Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
darshan
darshan
Commits
c16aa8a2
Commit
c16aa8a2
authored
Oct 22, 2020
by
Jakob Luettgau
Browse files
Add release checklist for PyDarshan.
parent
f849814f
Changes
1
Hide whitespace changes
Inline
Side-by-side
darshan-util/pydarshan/RELEASE-CHECKLIST-PyDarshan.txt
0 → 100644
View file @
c16aa8a2
Notes on how to release a new version of PyDarshan
2020-06
-----------------------
- Ensure python dev environment with dev dependencies, if not already present
(- python3 -m venv venv)
(- source venv/bin/activate)
(- pip install -r requirements_dev.txt # deps for packaging, testing, and docs generation)
If present:
- source venv/bin/activate
- export LD_LIBRARY_PATH=<libdarshanutils-path-to-test-against>/
- Make sure documentation in docs/ is up to date
- commit
- (might connect this with readthedocs to have this automatically, otherwise upload docs/_build/html/*)
- Update changelog or history.rst
- TODO: this does not apply when the release cycle coincides with darshan
- commit
- Update version numbers in:
setup.py
setup.cfg
darshan/__init__.py
- Run tests with tox against different python versions
- make test-all
- TODO: CI?
- Submit to PyPi using twine:
- make release
(be prompted for username/password)
- Add/update spack package: py-darshan
- add version entry
- add hash of release tar.gz from pypi (because that one should always exist) / or use mcs darshan mirror
- check if new dependencies are required (compare to requirements.txt)
- submit as pull request to https://github.com/spack/spack
- Announce:
- Regular Darshan Release: Copy release notes for PyDarshan and attach as seperate section (mailinglist, website/blog)
- PyDarshan only: Post release note section of PyDarshan (mailinglist, website/blog)
Note on Versionsformat:
Whenever libdarshan-utils has a version change, PyDarshan is bumped accordingly.
4th position version numbers allows for PyDarshan to be on a faster release cycle.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment