GreenPolyProducts/cantera
5
0
Fork 0
mirror of https://github.com/Cantera/cantera.git synced 2025-02-25 18:55:29 -06:00
Code Issues Packages Projects Releases Wiki Activity

[Doc] Update release instructions about doc deployment

Browse Source
This commit is contained in:
Ray Speth 2024-12-13 14:42:19 -05:00 committed by Ray Speth
parent 3b95454939
commit ef8aef81cf
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/sphinx/develop/distribution-packages/release-checklist.md
View File

@ -56,9 +56,6 @@ maintainers.
content.
## After Merging Release Pull Request
- Once the CI completes, download the `docs` artifact, extract it, and add the contents
to the `api-docs` repository.
- Update the recommended citation in `community.md` in the `cantera-website` repository,
including the year and DOI.
@ -73,6 +70,15 @@ maintainers.
git push upstream X.Y
```
- The CI job on the maintenance branch should upload the docs to the versioned path on
`cantera.org` and archive the docs in the `staging` branch of the
[`api-docs`](https://github.com/Cantera/api-docs/tree/staging) repository. Check that
this worked correctly and merge into the `main` branch if so. Consider squashing
multiple updates to the same version to keep this repository from growing too much.
- If this is a feature release, log into `cantera.org` and update the symlink
`/var/www/cantera/stable` to point to the docs for the new feature branch.
- Create the release tarball. This requires a couple of steps to merge the
`example_data` submodule in with the main source directories:
```sh