Skip to content

Commit d7917a8

Browse files
committed
update pydarshan RELEASE-CHECKLIST for getting Github action artifacts
1 parent 8a075c4 commit d7917a8

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

darshan-util/pydarshan/RELEASE-CHECKLIST-PyDarshan.txt

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,28 @@ Notes on how to release a new version of PyDarshan
77
(- source venv/bin/activate)
88
(- pip install .[dev,test] # deps for packaging, testing, and docs generation)
99

10-
- Update CHANGELOG.rst
11-
- commit
10+
- About updating CHANGELOG.rst
11+
- Since version 3.5.0, pydarshan released as a part of Darshan package, the
12+
change history should go to `ChangeLog` at root folder.
1213
- Update version numbers in:
1314
darshan/__init__.py
14-
- determine whether new job summary tool features warrant generating a new summary report to include in docs
15-
(stored @ /nfs/pub_html/gce/projects/darshan/docs/example_report.html)
15+
- About the pydarshan documents
16+
- Since version 3.5.0, all Darshan documents have been moved to
17+
readthedocs.io and are updated every time a new commit is pushed to the
18+
main branch.
1619

1720
- Submit to PyPI using cibuildwheel/twine:
1821
- pipx run build --sdist
1922
(in the pydarshan directory, creates a source distribution)
2023
- download wheel artifacts from GitHub, copy to 'dist/' directory created above
21-
(click on Actions in GitHub, find most recent "Build Wheels" workflow run with artifacts)
22-
(download artifact zip (called 'pydarshan-wheels-all'), extract wheels to 'dist/' directory)
24+
+ Click on Actions in GitHub. On the left panel, click "Build Wheels".
25+
+ Click on "Run workflow" to generate the artifacts. This will take about an hour.
26+
+ Click on the latest workflow run named "Build Wheels"
27+
+ At the bottom section, click the download icon to the right of
28+
'pydarshan-wheels-all' to download the artifact zip file, named
29+
'pydarshan-wheels-all.zip'.
30+
+ Copy the zip file to to 'dist/' directory and run command 'unzip' to
31+
extract the wheel files.
2332
- pipx run twine upload dist/*
2433
(requires PyPI credentials for darshan project)
2534
(use '--repository testpypi' to test wheels using https://test.pypi.org/project/darshan/ before uploading to PyPI)

0 commit comments

Comments
 (0)