Skip to content

Commit f6ae872

Browse files
author
Phil Carns
committed
update release checklist to reflect rtd docs
1 parent fcccadc commit f6ae872

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

darshan-test/RELEASE-CHECKLIST.txt

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ Notes on how to release a new version of Darshan
88
- close the milestone, move unfinished issues to appropriate milestone
99
2) check for any problems in recent CI workflows on the main GitHub and
1010
on the ALCF GitLab CI instance
11-
3) make sure that documentation in darshan-util/doc/ and darshan-runtime/doc/
12-
are up to date
13-
- commit
11+
3) make sure that documentation on Read the Docs is up to date. See
12+
instructions in readthedocs/DEVELOPER_NOTES.md
1413
4) update the Changelog, if needed (browse git log since last release)
1514
- commit
1615
5) update version number in top-level darshan.version file
@@ -31,6 +30,8 @@ Notes on how to release a new version of Darshan
3130
- example (annotated tag, pushed to repo):
3231
git tag -a darshan-2.3.1 -m 'Darshan 2.3.1'
3332
git push origin darshan-2.3.1
33+
- NOTE: update the above to reflect the tag format needed by Read the
34+
Docs
3435
11) manually create the release tarball
3536
- do a fresh checkout of the Darshan release tag
3637
git clone --branch darshan-2.3.1 \
@@ -42,15 +43,9 @@ Notes on how to release a new version of Darshan
4243
tar -czvf darshan-2.3.1.tar.gz /path/to/darshan-2.3.1
4344
- upload tarball to CELS server
4445
scp darshan-2.3.1.tar.gz [email protected]:/nfs/pub_html/gce/projects/darshan/releases/
45-
12) generate web documentation from asciidoc by running make in
46-
darshan-util/doc/ and darshan-runtime/doc/ directories
47-
- upload .html files to CELS server (/nfs/pub_html/gce/projects/darshan/docs)
48-
- This step is only applicable to release of 3.4.7 and prior. Documents of
49-
later releases have been migrated to readthedocs.io, which are
50-
automatically generated every time a new commit is pushed.
51-
13) update download page on darshan web site: www.mcs.anl.gov/darshan/download
52-
14) update darshan-runtime and darshan-util Spack packages with new release
46+
12) update download page on darshan web site: www.mcs.anl.gov/darshan/download
47+
13) update darshan-runtime and darshan-util Spack packages with new release
5348
- consider whether new variants should be exposed based on new features
5449
enabled by the release
5550
- commit, submit PR to upstream Spack repository
56-
15) announce on web page (new post) and mailing list
51+
14) announce on web page (new post) and mailing list

0 commit comments

Comments
 (0)