Git Product home page Git Product logo

Comments (2)

CSchank avatar CSchank commented on May 28, 2024

The Stack documentation gives some example config files for Travis CI. I am planning to optimize them for our purposes. Here is my proposal. I'd like some feedback. Travis spins up a virtual machine to check our code in ways we configure, sending results back to GitHub to, for example, disallow pull requests if something fails. It is automatic and triggered by things like pushes and pull requests being issued.

When committing to normal branches:

  1. Build with the project's default stack version
  2. Check hindent
  3. Run through haddock checker to ensure public things are documented properly.
    If these fail, the build will fail, helping the developer to fix those issues before issuing a PR.

When issuing pull requests or commits to develop:

  1. Build with the project's default version of stack
  2. Check hindent
  3. Run through haddock checker to ensure public things are documented properly.
    Either of these failing will cause the PR to be un-mergeable until they are fixed.

When issuing pull requests (and commits) to master (from develop probably):

  1. Check build with many versions of stack (e.g. LTS-9, 10, 11, 12} (and, if we decide to support it, cabal)
  2. Check hindent
  3. Check haddock documentation again.
    Don't allow merging until these are fixed.

In all cases, administrators have the right to force merges if it is deemed necessary / okay to do so. This will be on a case-by-case basis, but the aim is to help developers write better code before it makes it to the develop and especially master branches.

Let me know if I've missed anything or if you have suggestions.

from hashedexpression.

dandoh avatar dandoh commented on May 28, 2024

Sounds good to me!!

from hashedexpression.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.