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

Add release process documentation #19

Merged
merged 2 commits into from
Oct 13, 2023
Merged
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
59 changes: 59 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Release process for `nx-parallel`

## Introduction

Example `version number`

- 1.8.dev0 # development version of 1.8 (release candidate 1)
- 1.8rc1 # 1.8 release candidate 1
- 1.8rc2.dev0 # development version of 1.8 release candidate 2
- 1.8 # 1.8 release
- 1.9.dev0 # development version of 1.9 (release candidate 1)

## Process

- Set release variables:

export VERSION=<version number>
export PREVIOUS=<previous version number>
export ORG="networkx"
export REPO="nx-parallel"

- Autogenerate release notes

changelist ${ORG}/${REPO} v${PREVIOUS} main --version ${VERSION}

- Put the output of the above command at the top of `CHANGELOG.md`

- Update `__version__` in `nx_parallel/__init__.py`.

- Commit changes:

git add nx_parallel/__init__.py CHANGELOG.md
git commit -m "Designate ${VERSION} release"

- Tag the release in git:

git tag -s v${VERSION} -m "signed ${VERSION} tag"

If you do not have a gpg key, use -u instead; it is important for
Debian packaging that the tags are annotated

- Push the new meta-data to github:

git push --tags origin main

where `origin` is the name of the `github.com:networkx/nx-parallel`
repository

- Review the github release page:

https://github.com/networkx/nx-parallel/tags

- Update `__version__` in `nx_parallel/__init__.py`.

- Commit changes:

git add pyproject.toml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this line should add nx_parallel/__init__.py instead of pyproject.toml since the previous update step is changed.

git commit -m 'Bump version'
git push origin main