-
Notifications
You must be signed in to change notification settings - Fork 312
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Add release documentation #1051
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for aya-rs-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
7b99c54
to
0d7873c
Compare
This describes the current process for performing releases from the aya workspace. Signed-off-by: Dave Tucker <[email protected]>
0d7873c
to
480859a
Compare
I'm not changing this any more now 😓 Just updated a few links and commandline flags since the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 7 unresolved discussions (waiting on @dave-tucker)
RELEASE.md
line 9 at r1 (raw file):
### 0. Who can release? Only members of the aya-rs GitHub organization in the `owners` team have the
you could link to it: https://github.com/orgs/aya-rs/teams/owners
RELEASE.md
line 17 at r1 (raw file):
### 1. cargo smart-release This project uses [cargo-smart-release][cargo-smart-release] to automate the
I think you don't need to double up like this
RELEASE.md
line 54 at r1 (raw file):
Opening PRs for the changes made by the release would be a good enhancement in future releases. However, we also need to create the tags via GitHub action also - due to branch protection.
either "- also due to..." or drop the word also as it already appears earlier in the sentence
RELEASE.md
line 80 at r1 (raw file):
} ' aya/CHANGELOG.md)" gh release create aya-vX.Y.Z --title "aya vX.Y.Z" --notes "$NOTES"
consider prefixing the whole thing with an environment variable so that the user doesn't need to repeat the version twice
RELEASE.md
line 96 at r1 (raw file):
### can't release aya-ebpf because of cyclic dependencies This is a known issue described in [#1050][#150].
don't double up. also, mismatch (1050 vs 150)
RELEASE.md
line 110 at r1 (raw file):
edit the changelog entry in the crate's `CHANGELOG.md` file to include a note about the dependency update under the `## Unreleased` section. [c3f0c7dc][c3f0c7dc] is an example of such a commit.
don't double up
RELEASE.md
line 112 at r1 (raw file):
[c3f0c7dc][c3f0c7dc] is an example of such a commit. [c3f0c7dc]: https://github.com/aya-rs/aya/commit/c3f0c7dc3fb285da091454426eeda0723389f0f1
consider moving all the links down here, i believe that's typical markdown hygiene
This describes the current process for performing releases from the aya workspace.
This change is