1.8 KiB
1.8 KiB
Local development
A Makefile is available to perform project-related operations:
- Documentation - generate a local HTML copy of the GitHub wiki
- Static analysis - check that the code is compliant to PHP conventions
- Unit tests - ensure there are no regressions introduced by new commits
Automatic builds
Travis CI is a Continuous Integration build server, that runs a build:
- each time a commit is merged to the mainline (
masterbranch) - 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
- runs ESLint check
After all jobs have finished, Travis returns the results to GitHub:
- a status icon represents the result for the
masterbranch:
- Pull Requests are updated with the Travis result
- Green: all tests have passed
- Red: some tests failed
- Orange: tests are pending
Documentation
mkdocs is used to convert markdown documentation to HTML pages. The public documentation website is rendered and hosted by readthedocs.org. A copy of the documentation is also included in prebuilt release archives (doc/html/ path in your Shaarli installation). To generate the HTML documentation locally, install a recent version of Python setuptools and run make doc.