@@ -17,21 +17,53 @@ Notes on how to release a new version of PyDarshan
1717 readthedocs.io and are updated every time a new commit is pushed to the
1818 main branch.
1919
20- - Submit to PyPI using cibuildwheel/twine:
20+ - Upload darshan package to test.pypi / pypi.org using cibuildwheel/twine:
2121 - pipx run build --sdist
2222 (in the pydarshan directory, creates a source distribution)
23- - download wheel artifacts from GitHub, copy to 'dist/' directory created above
23+ - Download wheel artifacts from GitHub, copy them to 'dist/' directory
24+ created above.
2425 + 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 "Run workflow" to generate the artifacts. This will take
27+ about an hour.
2628 + Click on the latest workflow run named "Build Wheels"
2729 + At the bottom section, click the download icon to the right of
2830 'pydarshan-wheels-all' to download the artifact zip file, named
2931 'pydarshan-wheels-all.zip'.
3032 + Copy the zip file to to 'dist/' directory and run command 'unzip' to
3133 extract the wheel files.
32- - pipx run twine upload dist/*
33- (requires PyPI credentials for darshan project)
34- (use '--repository testpypi' to test wheels using https://test.pypi.org/project/darshan/ before uploading to PyPI)
34+ + Delete the zip file.
35+ - Test package on test.pypi.org first
36+ 0. This requires test.pypi.org credentials for darshan project.
37+ 1. Upload pydarshan package to testpypi by running command:
38+ "pipx run twine upload --repository testpypi dist/*"
39+ 2. Go to https://test.pypi.org on a browser and search for package name
40+ of "darshan" to verify if the right version appears there.
41+ 3. Test the package on your local machine.
42+ a. Uninstall exiting darshan from your environment by running
43+ command "pip uninstall darshan"
44+ b. Install darshan by running command
45+ "pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple darshan==3.5.0"
46+ c. Verify by running command "pip show darshan"
47+ d. Download the official darshan source code tar ball, e.g.
48+ darshan-3.5.0.tar.gz, and untar it.
49+ e. cd darshan-3.5.0/darshan-util/pydarshan
50+ f. Make sure necessary python packages are installed by running
51+ command "pip install tox coverage flake8"
52+ g. Test by running commands:
53+ + make test
54+ + make test-all
55+ + make coverage
56+ + make lint
57+ h. Uninstall the test package by running command
58+ "pip uninstall darshan"
59+ 4. When all the above tests passed, the package is ready for the
60+ official release.
61+ - Upload the package to PYPI
62+ + This requires PyPI credentials for darshan project
63+ + Official python packages are stored at pypi.org.
64+ + Run command "pipx run twine upload dist/*"
65+ + Go to https://pypi.org on a browser and search for package name
66+ of "darshan" to verify if the right version appears there.
3567
3668 - Add/update spack package: py-darshan
3769 - add version entry
0 commit comments