Skip to content

Commit

Permalink
update Readme instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mschwoer committed Aug 27, 2024
1 parent c51761c commit 9301363
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions docs/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,16 @@
This document gathers information on how to develop and contribute to the alphaDIA project.

## Release process

### Tagging of changes
In order to have release notes automatically generated, changes need to be tagged with labels.
The following labels are used (should be safe-explanatory):
`breaking-change`, `bug`, `enhancement`.

### Release a new version
Note: Releases need to be done from the `main` branch.

1. Bump the version locally to (e.g. to `X.Y.Z`) and merge the change to `main`.
2. Create a new draft release on GitHub using the
[Create Draft Release](https://github.com/MannLabs/alphadia/actions/workflows/create_release.yml) workflow.
You need to specify the commit to release, and the release tag (e.g. `vX.Y.Z`).
3. Test the release manually.
4. Add release notes and publish the release on GitHub.
5. Run the [Publish on PyPi](https://github.com/MannLabs/alphadia/actions/workflows/publish_on_pypi.yml) workflow,
specifying the release tag (e.g. `vX.Y.Z`).
6. Run the [Publish Docker Image](https://github.com/MannLabs/alphadia/actions/workflows/publish_docker_image.yml) workflow,
specifying the release tag (e.g. `vX.Y.Z`).
This package uses a shared release process defined in the
[alphashared](https://github.com/MannLabs/alphashared) repository. Please see the instructions
[there](https://github.com/MannLabs/alphashared/blob/reusable-release-workflow/.github/workflows/README.md#release-a-new-version)


## Notes for developers
Expand Down

0 comments on commit 9301363

Please sign in to comment.