Process
- Set release variables:
export VERSION=<version number>
export PREVIOUS=<previous version number>
export ORG="networkx"
export REPO="nx-parallel"
export LOG="CHANGELOG.md"
- Autogenerate release notes
changelist ${ORG}/${REPO} v${PREVIOUS} main --version ${VERSION} --out ${VERSION}.md
- Put the output of the above command at the top of `CHANGELOG.md`
cat ${VERSION}.md | cat - ${LOG} > temp && mv temp ${LOG}
- Update `__version__` in `nx_parallel/__init__.py`.
- Commit changes:
git add nx_parallel/__init__.py ${LOG}
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
- Create release from tag
- go to https://github.com/networkx/nx-parallel/releases/new?tag=v${VERSION}
- add v${VERSION} for the `Release title`
- paste contents (or upload) of ${VERSION}.md in the `Describe this release section`
- if pre-release check the box labelled `Set as a pre-release`
- Update https://github.com/networkx/nx-parallel/milestones:
- close old milestone
- ensure new milestone exists (perhaps setting due date)
- Update `__version__` in `nx_parallel/__init__.py`.
- Commit changes:
git add nx_parallel/__init__.py
git commit -m 'Bump version'
git push origin main