Document release procedures #725
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 tasks
jedbrown
changed the title
|
Thanks for starting this. Having recently refactored the Rust crates and gone through with releasing them, here's an update to the process. We could include more testing of the packaged crates like I describe for Python. Comments welcome, and rendered file here: https://github.com/CEED/libCEED/blob/releasing-notes/RELEASING.md |
jeremylt
reviewed
Jun 2, 2021
valeriabarra
reviewed
Jun 2, 2021
| * `ceed.pc.template` | ||
| * `Doxyfile` | ||
|
|
||
| Additionally, the release notes in `doc/sphinx/source/releasenotes.rst` should be updated. Use `git log --first-parent v0.7..` to get a sense of the pull requests that have been merged and thus might warrant emphasizing in the release notes. While doing this, gather a couple sentences for key features to highlight on [GitHub releases](https://github.com/CEED/libCEED/releases). The "Current Main" heading needs to be named for the release. |
There was a problem hiding this comment.
Should we add any reference here in updating the User Manual version? That can easily fall out of date (as it is now)
There was a problem hiding this comment.
Updated now, and here's a PR for the users manual #777
You can find the version history here.
https://zenodo.org/record/4895340
pazner
commented
Jun 2, 2021
pazner
commented
Jun 2, 2021
jedbrown
approved these changes
Jun 2, 2021
Co-authored-by: Jeremy L Thompson <25011573+jeremylt@users.noreply.github.com> Co-authored-by: Will Pazner <11493037+pazner@users.noreply.github.com> Reported-by: Valeria Barra <valeriabarra21@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add some documentation for the release procedure. For now I've added documentation for the Julia interface, @jedbrown can add notes for C, Python, and Rust.