Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version bump and release docs #35

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Release

Assumptions:

* `main` branch can wait until release PR is merged

The steps:

1. **release**:
1. **review adjust if needed the release version in `main`** to match the changes from the latest release following the [SemVer rules](https://semver.org/#summary).
2. [create](https://github.com/sicpa-dlab/peer-did-python/compare/stable...main) a **PR from `main` to `stable`** (you may likely want to name it as `release-<version>`)
3. once merged [release pipeline](https://github.com/sicpa-dlab/peer-did-python/actions/workflows/release.yml) will publish the release to [PyPI](https://pypi.org/project/peerdid)
2. **bump next release version in `main`**
* **Note** decision about the next release version should be based on the same [SemVer](https://semver.org/) rules and the expected changes. Usually it would be either a MINOR or MAJOR (if incompatible changes are planned) release.
2 changes: 1 addition & 1 deletion peerdid/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.4.0"
__version__ = "0.5.0"