diff options
author | ArthurHoaro <arthur@hoa.ro> | 2018-07-28 11:07:55 +0200 |
---|---|---|
committer | ArthurHoaro <arthur@hoa.ro> | 2018-07-28 11:07:55 +0200 |
commit | 83faedadff76c5bdca036f39f13943f63b27e164 (patch) | |
tree | 6f44cede16ec6a60f10b9699e211e0818f06d2c8 /doc/md/Continuous-integration-tools.md | |
parent | 1d9eb22a3df85b67fe6652c0876cd7382c2fb525 (diff) | |
parent | 658988f3aeba7a5a938783249ccf2765251e5597 (diff) | |
download | Shaarli-83faedadff76c5bdca036f39f13943f63b27e164.tar.gz Shaarli-83faedadff76c5bdca036f39f13943f63b27e164.tar.zst Shaarli-83faedadff76c5bdca036f39f13943f63b27e164.zip |
Merge tag 'v0.9.7' into stable
Release v0.9.7
Diffstat (limited to 'doc/md/Continuous-integration-tools.md')
-rw-r--r-- | doc/md/Continuous-integration-tools.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/md/Continuous-integration-tools.md b/doc/md/Continuous-integration-tools.md new file mode 100644 index 00000000..4bd7a0ba --- /dev/null +++ b/doc/md/Continuous-integration-tools.md | |||
@@ -0,0 +1,28 @@ | |||
1 | ## Local development | ||
2 | A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations: | ||
3 | |||
4 | - Documentation - generate a local HTML copy of the GitHub wiki | ||
5 | - [Static analysis](Static analysis) - check that the code is compliant to PHP conventions | ||
6 | - [Unit tests](Unit tests) - ensure there are no regressions introduced by new commits | ||
7 | |||
8 | ## Automatic builds | ||
9 | [Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build: | ||
10 | |||
11 | - each time a commit is merged to the mainline (`master` branch) | ||
12 | - each time a Pull Request is submitted or updated | ||
13 | |||
14 | A build is composed of several jobs: one for each supported PHP version (see [Server requirements](Server requirements)). | ||
15 | |||
16 | Each build job: | ||
17 | |||
18 | - updates Composer | ||
19 | - installs 3rd-party test dependencies with Composer | ||
20 | - runs [Unit tests](Unit tests) | ||
21 | |||
22 | After all jobs have finished, Travis returns the results to GitHub: | ||
23 | |||
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) | ||
25 | - Pull Requests are updated with the Travis result | ||
26 | - Green: all tests have passed | ||
27 | - Red: some tests failed | ||
28 | - Orange: tests are pending | ||