Skip to content

Commit

Permalink
docs: upgrade the docs to rely on bwa-aln-interactive in bioconda
Browse files Browse the repository at this point in the history
  • Loading branch information
clintval committed Sep 20, 2024
1 parent a57c1c1 commit 2aabb82
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 #.#.#`
Expand All @@ -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
Expand Down

0 comments on commit 2aabb82

Please sign in to comment.