Skip to content

Commit

Permalink
Update the readme with how to release
Browse files Browse the repository at this point in the history
  • Loading branch information
unkcpz committed Feb 27, 2024
1 parent 440b1dd commit 671653d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Hosted on [aiidalab-widgets-base.readthedocs.io](https://aiidalab-widgets-base.r

## For maintainers

To create a new release, clone the repository, install development dependencies with `pip install -e '.[dev]'`, and then execute `bumpver update [--major|--minor|--patch] [--tag-num --tag [alpha|beta|rc]]`.
This will:
To create a new release, clone the repository, checkout to the desired release version say, `release/2.2.0`. Install development dependencies with `pip install -e '.[dev]'`, and then execute `bumpver update [--major|--minor|--patch] [--tag-num --tag [alpha|beta|rc]]`. Make a PR to the `main` branch (or `support/x` branch for backport support with cherry-pick commits from `main`).

1. Create a tagged release with bumped version and push it to the repository.
2. Trigger a GitHub actions workflow that creates a GitHub release and publishes it on PyPI.
This will trigger a GHA workflow that test publish to TestPyPI.

Once the PR is merged, [create a new release on GitHub](https://github.com/aiidalab/aiidalab-widgets-base/releases/new) with the tag name `v2.2.0` and the release title `v2.2.0`. This will trigger a GHA workflow that publishes to PyPI.

Additional notes:

Expand Down

0 comments on commit 671653d

Please sign in to comment.