diff options
author | VirtualTam <virtualtam+github@flibidi.net> | 2017-08-06 16:15:32 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-08-06 16:15:32 +0200 |
commit | c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f (patch) | |
tree | 03e4d7bbdcfebdb704266caf4b5c0d87e90c02ce /doc/md/Continuous-integration-tools.md | |
parent | 4758c18164f8168be0b3e422c4af86827c913390 (diff) | |
parent | f320efd689f17737ccbdef46cdc430d9e637b807 (diff) | |
download | Shaarli-c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f.tar.gz Shaarli-c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f.tar.zst Shaarli-c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f.zip |
Merge pull request #917 from virtualtam/documentation/fixes+improvements
Documentation fixes, improvements and additions
Diffstat (limited to 'doc/md/Continuous-integration-tools.md')
-rw-r--r-- | doc/md/Continuous-integration-tools.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/md/Continuous-integration-tools.md b/doc/md/Continuous-integration-tools.md index 849257f7..4bd7a0ba 100644 --- a/doc/md/Continuous-integration-tools.md +++ b/doc/md/Continuous-integration-tools.md | |||
@@ -1,22 +1,26 @@ | |||
1 | ## Local development | 1 | ## Local development |
2 | A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations: | 2 | A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations: |
3 | |||
3 | - Documentation - generate a local HTML copy of the GitHub wiki | 4 | - Documentation - generate a local HTML copy of the GitHub wiki |
4 | - [Static analysis](Static analysis) - check that the code is compliant to PHP conventions | 5 | - [Static analysis](Static analysis) - check that the code is compliant to PHP conventions |
5 | - [Unit tests](Unit tests) - ensure there are no regressions introduced by new commits | 6 | - [Unit tests](Unit tests) - ensure there are no regressions introduced by new commits |
6 | 7 | ||
7 | ## Automatic builds | 8 | ## Automatic builds |
8 | [Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build: | 9 | [Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build: |
10 | |||
9 | - each time a commit is merged to the mainline (`master` branch) | 11 | - each time a commit is merged to the mainline (`master` branch) |
10 | - each time a Pull Request is submitted or updated | 12 | - each time a Pull Request is submitted or updated |
11 | 13 | ||
12 | A build is composed of several jobs: one for each supported PHP version (see [Server requirements](Server requirements)). | 14 | A build is composed of several jobs: one for each supported PHP version (see [Server requirements](Server requirements)). |
13 | 15 | ||
14 | Each build job: | 16 | Each build job: |
17 | |||
15 | - updates Composer | 18 | - updates Composer |
16 | - installs 3rd-party test dependencies with Composer | 19 | - installs 3rd-party test dependencies with Composer |
17 | - runs [Unit tests](Unit tests) | 20 | - runs [Unit tests](Unit tests) |
18 | 21 | ||
19 | After all jobs have finished, Travis returns the results to GitHub: | 22 | After all jobs have finished, Travis returns the results to GitHub: |
23 | |||
20 | - a status icon represents the result for the `master` branch: [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli) | 24 | - a status icon represents the result for the `master` branch: [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli) |
21 | - Pull Requests are updated with the Travis result | 25 | - Pull Requests are updated with the Travis result |
22 | - Green: all tests have passed | 26 | - Green: all tests have passed |