diff options
author | VirtualTam <virtualtam@flibidi.net> | 2017-08-05 11:56:24 +0200 |
---|---|---|
committer | VirtualTam <virtualtam@flibidi.net> | 2017-08-05 11:56:24 +0200 |
commit | 43ad7c8e825057747ccf02049050b323878952a7 (patch) | |
tree | 3160fd640c42f41a38d6c1df2cd4e020f87942ae /doc/md/Continuous-integration-tools.md | |
parent | b4ff0afb24db6e4cb3543bbd71f01bbb0716b144 (diff) | |
download | Shaarli-43ad7c8e825057747ccf02049050b323878952a7.tar.gz Shaarli-43ad7c8e825057747ccf02049050b323878952a7.tar.zst Shaarli-43ad7c8e825057747ccf02049050b323878952a7.zip |
documentation: fix rendering and internal references
This is mainly cleanup after switching from Github-flavoured Markdown
rendered by Github Pages, to standard Markdown rendered by MkDocs.
Changed:
- rephrase some section titles
Fixed:
- list rendering (items, sub-items))
- code rendering
- quotes
- dead links
Removed:
- extraneous navigational elements
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
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 |