ci: automate release issue creation #12741
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
galargh
added
the
skip/changelog
galargh
changed the title
8 tasks
* ci: automate release issue creation from v1.32.0 learnings * Self-review feedback from looking at #12749 * Fix String contains ordering bugs. * chore: run gofmt --------- Co-authored-by: galargh <piotr.galar@gmail.com>
|
@BigLep Lovely! Thank you for that. I now merged your follow-up into this PR. Let me know if there's anything else we should take care of in this iteration. |
8 tasks
rvagg
reviewed
Dec 5, 2024
rvagg
reviewed
Dec 5, 2024
rvagg
reviewed
Dec 5, 2024
rvagg
approved these changes
Dec 5, 2024
Co-authored-by: Rod Vagg <rod@vagg.org>
Co-authored-by: Rod Vagg <rod@vagg.org>
rvagg
reviewed
Dec 5, 2024
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.
Related Issues
Resolves #12477
Proposed Changes
This PR implements the release issue creation automation.
Firstly, it turns the
RELEASE_ISSUE_TEMPLATE.mdinto a Go template. This allowed us to use variable substitution and conditional blocks, which were the prerequisites for release issue rendering. We used variable substitution inline. We hid the conditional block starts/ends in HTML comment tags (<!--,-->). We kept the modifications to a minimum and ensured that the template could still be copied manually and updated using almost the same steps as before.Secondly, we added a new command -
create-issue- to thecmd/releasetool. The command accepts a number of flags, values of which are then used to render the issue template. Before creating a new issue, the command checks whether if it already exists. It requires GITHUB_TOKEN with write access to issues to be present in the environment. The command doesn't operate in interactive mode. It expects all the data to be provided via flags instead.Finally, we created a new GitHub Actions workflow which accepts exactly the same inputs as the command and calls it to create the new release issue. It can be triggered on demand.
Additional Info
An example of the release issue created using
release create-issue --type node --tag 1.2.3 --level patch --network-upgrade 23: galargh/.github#73Checklist
Before you mark the PR ready for review, please make sure that: