Skip to content

Commit

Permalink
Update documentation: Remove tox & introduce GitHub Actions workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
goessebr committed Jun 24, 2024
1 parent 6eb6452 commit ba45836
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 11 deletions.
15 changes: 5 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,13 @@ contribution. For certain changes, such as updating a part of the documentation
this is not necessary.

We place a lot of importance on code quality, expect to have a good
amount of code coverage present and run frequent unit tests. All commits and
pull requests will be tested with [Travis-ci]. Code coverage is being
monitored with [Coveralls].
amount of code coverage present and run frequent unit tests. All commits and pull
requests will be automatically tested using [GitHub Actions workflows].
Code coverage is being monitored with [Coveralls].

Locally you can run unit tests by using [pytest] or [tox]. Running pytest
manually is good for running a distinct set of unit tests. For a full test run,
tox is preferred since this can run the unit tests against multiple versions of
python.
Locally you can run unit tests by using [pytest].

```bash
# Run unit tests for all environments
$ tox
# No coverage
$ py.test
# Coverage
Expand Down Expand Up @@ -68,4 +63,4 @@ know why it's not working.
[Travis-ci]: https://travis-ci.org/OnroerendErfgoed/atramhasis
[Coveralls]: https://coveralls.io/r/OnroerendErfgoed/atramhasis
[pytest]: http://pytest.org
[tox]: http://tox.readthedocs.org
[GitHub Actions workflows]: https://github.com/OnroerendErfgoed/atramhasis/actions
2 changes: 1 addition & 1 deletion docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ Alternatively, you can specify your build as a wheel or as a source distribution
.. _Flanders Heritage Agency: https://www.onroerenderfgoed.be
.. _Github page for Atramhasis: https://github.com/OnroerendErfgoed/atramhasis
.. _Github Workflow Actions tests: https://github.com/OnroerendErfgoed/atramhasis/actions/workflows/atramhasis_backend.yaml
.. _GitHub Actions workflows: https://github.com/OnroerendErfgoed/atramhasis/actions
.. _Coveralls: https://coveralls.io/r/OnroerendErfgoed/atramhasis
.. _pytest: http://pytest.org
.. _npm: https://www.npmjs.org/
Expand Down

0 comments on commit ba45836

Please sign in to comment.