X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FContinuous-integration-tools.md;h=4ca6bdc7aab9cf503b2de1ee90f1636e12ec1e8d;hb=4fa9a3c5d83a1024678596a586afe5df14a345b5;hp=849257f70c486e0f8da335f805c32cd7a751025c;hpb=0433c688b9be6097b85a8fec31b3dacd0ab81677;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/Continuous-integration-tools.md b/doc/md/Continuous-integration-tools.md index 849257f7..4ca6bdc7 100644 --- a/doc/md/Continuous-integration-tools.md +++ b/doc/md/Continuous-integration-tools.md @@ -1,22 +1,27 @@ ## Local development A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations: + - Documentation - generate a local HTML copy of the GitHub wiki -- [Static analysis](Static analysis) - check that the code is compliant to PHP conventions -- [Unit tests](Unit tests) - ensure there are no regressions introduced by new commits +- [Static analysis](Static-analysis) - check that the code is compliant to PHP conventions +- [Unit tests](Unit-tests) - ensure there are no regressions introduced by new commits ## Automatic builds [Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build: + - each time a commit is merged to the mainline (`master` branch) - each time a Pull Request is submitted or updated A build is composed of several jobs: one for each supported PHP version (see [Server requirements](Server requirements)). Each build job: + - updates Composer - installs 3rd-party test dependencies with Composer -- runs [Unit tests](Unit tests) +- runs [Unit tests](Unit-tests) +- runs ESLint check After all jobs have finished, Travis returns the results to GitHub: + - a status icon represents the result for the `master` branch: [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli) - Pull Requests are updated with the Travis result - Green: all tests have passed