32 lines
1.8 KiB
Markdown
32 lines
1.8 KiB
Markdown
## 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
|
|
|
|
## 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 ESLint check
|
|
|
|
After all jobs have finished, Travis returns the results to GitHub:
|
|
|
|
- a status icon represents the result for the `master` branch: [](https://travis-ci.org/shaarli/Shaarli)
|
|
- Pull Requests are updated with the Travis result
|
|
- Green: all tests have passed
|
|
- Red: some tests failed
|
|
- Orange: tests are pending
|
|
|
|
## Documentation
|
|
[mkdocs](https://www.mkdocs.org/) is used to convert markdown documentation to HTML pages. The [public documentation](https://shaarli.readthedocs.io/en/master/) website is rendered and hosted by [readthedocs.org](https://readthedocs.org/). A copy of the documentation is also included in prebuilt [release archives](https://github.com/shaarli/Shaarli/releases) (`doc/html/` path in your Shaarli installation). To generate the HTML documentation locally, install a recent version of Python `setuptools` and rune `make doc`.
|