1.5 KiB
1.5 KiB
The wwt_data_formats release process
These are notes for the wwt_data_formats
developers about how to create a new release.
- Create a branch intended to become the next release.
- Finish features, test functionality, etc.
python setup.py sdist
and verify contents.- Make sure that
CHANGES.md
is up-to-date. - For the final commit, update the version number in
setup.py
anddocs/conf.py
, and add a proper version and date toCHANGES.md
. Commit with messageRelease version ${version}
. - Push to GitHub and create a pull request for the new release called "Release PR for version $version".
- Get it so that it passes CI, creating fixup commits as necessary.
- When it's really really ready,
git clean -fxd && python setup.py sdist && twine upload dist/*.tar.gz
. Iftwine
finds problems, make any final changes and retry. - If needed, do a
git rebase -i
to make the version-bump commit the last one again. git tag v${version}
- Update the version number to
${cur_major}.${next_minor}.0.dev0
and add a new separator inCHANGES.md
along the lines ofNext version (unreleased)
. Commit with a message ofBack to development.
git push
(with-f
if history was rewritten) to the PR branch. This had really better still pass CI.- Merge into
master
. - Pull the merged
master
locally. git push --tags
- Create a new release on GitHub and copy the latest contents of
CHANGES.md
into the description.