diff --git a/docs/installation.md b/docs/installation.md index 7c3e13d..4e0e612 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -36,7 +36,8 @@ mamba install -c bioconda prymer Make sure that [instructions for development work](#getting-setup-for-development-work) have been followed. Use `poetry` to format, lint, type-check, and test your code. -Note that `poetry run pytest` will run `mypy` and `ruff` code checks, `pytest` unit tests, and will provide a unit test coverage report. + +Note that `poetry run pytest` will run `mypy` and `ruff` checks, `pytest` unit tests, and will provide a unit test coverage report. ```console poetry run pytest @@ -58,14 +59,6 @@ poetry run mkdocs build && poetry run mkdocs serve ## Creating a Release on PyPi -> [!NOTE] -> This tool follows [Semantic Versioning](https://semver.org/). -> In brief: -> -> * `MAJOR` version when you make incompatible API changes -> * `MINOR` version when you add functionality in a backwards compatible manner -> * `PATCH` version when you make backwards compatible bug fixes - 1. Clone the repository recursively and ensure you are on the `main` (un-dirty) branch 2. Checkout a new branch to prepare the library for release 3. Bump the version of the library to the desired SemVer with `poetry version #.#.#` @@ -74,6 +67,14 @@ poetry run mkdocs build && poetry run mkdocs serve 6. Squash merge the PR 7. Tag the new commit on the main branch of the repository with the new SemVer +> [!NOTE] +> This project follows [Semantic Versioning](https://semver.org/). +> In brief: +> +> * `MAJOR` version when you make incompatible API changes +> * `MINOR` version when you add functionality in a backwards compatible manner +> * `PATCH` version when you make backwards compatible bug fixes + GitHub Actions will take care of the remainder of the deployment and release process with: 1. Unit tests will be run for safety-sake