Docs/release howto#723
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #723 +/- ##
=======================================
Coverage 94.50% 94.50%
=======================================
Files 67 67
Lines 5277 5277
=======================================
Hits 4987 4987
Misses 290 290 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Update release process steps in contributing how-to.
|
Just checked this, thanks @kaiser-dan. |
Co-authored-by: Maxime Lucas <maximelucas@users.noreply.github.com>
Yes, we should! Good catch, thank you. I will add that to this PR later today or tomorrow (my SIAM presentation is today! I will be MIA until after that) and ping you when its ready. |
| - Style is maintained (see 'Format codebase' above) | ||
| - The changelog is updated. Paste the output of `python tools/generate_changelog.py -m xgi-org xgi [last release tag]` into a new heading for the proposed release (`vMAJOR.MINOR.PATCH` without the 'rc'). | ||
| 3. Await approval for the PR. | ||
| 4. Once the PR is approved, the approving/merging maintainer must bump the version number. Increase the version number in [\_\_init\_\_.py](xgi/__init__.py.py) to the new version. Commit these changes with the commit message "bump: v[last release] -> v[proposed release]". No new approval is needed for this tiny change. |
There was a problem hiding this comment.
Wondering if you can use bold to indicate "THIS PART IS ON DEV". Or alternatively, say something like "ALL CODE MODIFICATIONS SHOULD BE DONE ON DEV OR BRANCHES FROM DEV"
nwlandry
left a comment
nwlandry
left a comment
There was a problem hiding this comment.
Overall looks good! Just a few things to address.
| 5. Merge the PR. | ||
| 6. Create a new release on GitHub by selecting "Releases", then clicking "Draft a new release". Click "Choose a tag" and type "v" followed by the version number and then click "Create new tag". The release title will be this same string. Paste the contents of the CHANGELOG into the "Describe this release" field. Click "Publish release". This will trigger a GitHub action that will publish the new version on PyPI. | ||
|
|
||
| The new version is now on PyPI! Make sure to update wherever you use xgi :) |
There was a problem hiding this comment.
Wondering if we need a "What to do if someone squashes and merges Dev into main/commits directly to main/deletes dev, etc." section
3 participants
Description
Update new release instructions. Closes #717 .