|
1 | | -- To release a new version of proteus |
2 | | -Update proteus/__init__.py (remove '.dev0' and increment version) |
3 | | -Update setup.py (remove 'dev0' and increment version) |
4 | | -Update doc/source/_templates/layout.html (added line for new release in pull down, set to default download to current release) |
5 | | -rebuild docs and check docs |
6 | | - cd .. |
7 | | - git clone https://github.com/erdc-cm/proteus proteus-website -b gh-pages |
8 | | - cd proteus |
9 | | - make docs |
10 | | -When you are satisified with both the current proteus commit and the docs commit and push proteus, and tag the release through the github releases site. Then commit the proteus-website gh-pages branch to publish the documentation on proteustoolkit.org |
| 1 | +# Releasing a new version of proteus |
11 | 2 |
|
12 | | -- Switch back to dev |
13 | | - |
14 | | -Update proteus/__init__.py (add '.dev0' to version) |
15 | | -Update setup.py (add '.dev0' to version) |
| 3 | +* Submit a PR with the following changes |
| 4 | + * Create release candidate branch on your fork (e.g. rcX.Y.Z) |
| 5 | + * Update proteus/__init__.py (remove '.dev0' and increment version) |
| 6 | + * Update setup.py (remove 'dev0' and increment version) |
| 7 | + * Update docs/Doxyfile (remove '.dev0' and increment version) |
| 8 | + * Submit PR and request two reviewers |
| 9 | + * Wait for it to be merged into master |
| 10 | +* Check the documentation generated by Travis from tests on master for any issues |
| 11 | + * Clone erdc/proteus-docs |
| 12 | + * Checkout master |
| 13 | + * Open index.html in your browser and check the website (e.g. version numbers, math/diagram rendering) |
| 14 | + * Merge master into gh-pages in the proteus-docs repo |
| 15 | +* Draft release on erdc/proteus |
| 16 | + * List signficant changes and contributors since last release |
| 17 | +* Clean up |
| 18 | + * Create devX.Y.Z branch |
| 19 | + * Update the version numbers back to X.Y.Z.dev0 |
0 commit comments