Skip to content
Snippets Groups Projects
Commit bb192126 authored by nimrod's avatar nimrod
Browse files

Document development and release.

parent d3e83c48
No related branches found
No related tags found
No related merge requests found
Pipeline #1983 passed
......@@ -7,3 +7,7 @@ dist/mnpw: mnpw/*.py pyproject.toml *.rst LICENSE.txt
.PHONY: clean
clean:
git clean --force -X -d
.PHONY: bats
bats: all
bats tests/
......@@ -48,6 +48,37 @@ plugin handling useful and would want to use it. The package is not published to
PyPI so your best option is getting a direct download of the wheel package from
the `releases pages <https://git.shore.co.il/shore/mnpw/-/releases>`_.
Development
-----------
For local development, the following is required:
- Python 3.6 or newer.
- `Poetry <https://python-poetry.org/>`_.
- `Bats <https://bats-core.readthedocs.io/en/stable/>`_.
- Make.
To run all of the tests locally:
.. code:: shell
poetry install
poetry run pre-commit run --all-files
poetry run pytest
poetry run make bats
All of those tests (and more) run in the `CI pipeline
<https://git.shore.co.il/shore/mnpw/-/pipelines>`_ on each push.
To release a new verion:
.. code:: shell
poetry run bumpversion major|minor|patch
This will commit the version change, tag and push it and the pipeline will
release a new version.
License
-------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment