Skip to content

Commit

Permalink
Add RELEASE-PROCESS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Angelina-C committed Apr 17, 2024
1 parent 637ca51 commit cddf5ad
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
6 changes: 0 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,3 @@ Thank you for considering contributing to our project! Please take a moment to r
## License

By contributing to this project, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE.txt).

## Releasing

- Creating a release in GitHub automatically triggers publication on PyPI. Please ensure that your changes are properly documented in the release notes.
- Semantic versioning should be used
- The tag should be of the form v{version}.
17 changes: 17 additions & 0 deletions RELEASE-PROCESS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Release process

## Versioning
Semantic versioning should be used, eg 1.2.3.

## Tag
The tag should be of the form v{version}.

## Creating a release
- In GitHub, go to releases.
- Select `Draft a new release`.
- Choose a tag - you can create a new tag here. Make sure it is the same as the version in `setup.py`.
- Click `Generate release ntoes`.
- Make sure `Set as latest release` is selected.
- Click `Publish release`.

- Creating a release in GitHub automatically triggers publication on PyPI.

0 comments on commit cddf5ad

Please sign in to comment.