Release 0.2.1 checklist
andrewkern opened this issue · 3 comments
andrewkern commented
Checklist for doing a new release, copied from the last one (#1319):
- Update Changelog for new release via PR
- Create a release using the GitHub UI. This creates the appropriate tag.
- Locally,
git fetch upstream --tags
,git checkout upstream/main
-
python3 -m build
(note: you need thebuild
andtwine
modules installed) -
python3 -m twine upload dist/[stuff]
for instancepython -m twine upload dist/{stdpopsim-0.2.1a1.tar.gz,stdpopsim-0.2.1a1-py3-none-any.whl}
(note: this now uses "API tokens" from PyPI possibly stored in~/.pypirc
to upload; see here for the ever-changing procedure) - check on pypi that the update actually worked
- check docs build succeeded (also check the docs URL substituting the release tag where
latest
orstable
usually is) - upload to zenodo
- update version and DOI in CITATION.cff (once added)
- conda-forge will do an automatic PR in the stdpopsim-feedstock repo; winni2k says:
"The key things I checked were that the version number is correct, the SHA sum has changed, and that the build number is reset to zero. Any other problems should be caught by the automated build system."
Post-release:
- make copy of this issue for the next release
Reference: https://packaging.python.org/tutorials/packaging-projects/, tskit-dev/pyslim#292
petrelharp commented
Here is the list of issues to do: https://github.com/popsim-consortium/stdpopsim/milestone/4
Major topics:
- ensembl build!!: #1521,
- move
stdpopsim/ext/
to juststdpopsim/
: #1373 - DFE QC: #1321, #1344, #1484, #1507
- SLiM support: #1343, #1563
- documentation/catalog info: #1403, #1449, #1509, #1541
- misc bugs involving breaking changes: #1404 (which should solve #1422), #1496, #1558
- usability and testing: #1405, #1418, #1451, #1467, #1493, #1549, #1577
- check in on versions of requirements
petrelharp commented