Skip to content

Commit

Permalink
Add instructions for how to release to PyPI
Browse files Browse the repository at this point in the history
  • Loading branch information
Splines committed Mar 19, 2024
1 parent 78aa5de commit 0d58dc5
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,15 @@ Also try adding `import pytest` as first line of a test file. Does it give you a
Note that tests are also run on every commit via a GitHub action.

In order to learn how to write the tests with pytest, start with the [`Get Started` guide](https://docs.pytest.org/en/8.0.x/getting-started.html#create-your-first-test). Probably also relevant: ["How to use fixtures"](https://docs.pytest.org/en/8.0.x/how-to/fixtures.html). There are lots of [How-to guides](https://docs.pytest.org/en/8.0.x/how-to/index.html) available.


## Release to PyPI

To release a new version to [PyPI](https://pypi.org/project/resultwizard/), do the following:

- Create a PR that is going to get merged into `main`. Name it "Continuous Release <version number, e.g. 1.0.0-alpha.42>".
- Make sure all tests pass and review the PR. Merge it into `main` via a *Merge commit*
<br>(from `dev` to `main` always via *Merge commit*, not *Rebase* or *Squash and merge*).
- On `main`, create a new release on GitHub. In this process (via the GitHub UI), create a new tag named "v<version number>", e.g. "v1.0.0-alpha.42".
- The tag creation will trigger a GitHub action that builds and uploads the package to PyPI. As this action uses a special "release" environment, code owners have to approve this step.
- Make sure the new version is available on PyPI [here](https://pypi.org/project/resultwizard/).

0 comments on commit 0d58dc5

Please sign in to comment.