README improvements + typo fix #249
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
Member
qmonnet
commented
Jul 30, 2024
•
qmonnet
commented
- Add logo to repository
- README.md: Expand doc, tell how to generate release notes
- changelog: Fix typo (duplicate 'of') in command help
- README.md: Remove outdated instruction for GITHUB_TOKEN
Signed-off-by: Quentin Monnet <[email protected]>
The release utility can also be used to generate the checklists for the release. Let's expand the doc to mention the "release help" command, and introduce the "release checklist" feature. Note that the example for creating a new patch release issue relies on the legacy template, not the new one (I expect the new one to be renamed and replace the old one, eventually?). Signed-off-by: Quentin Monnet <[email protected]>
Signed-off-by: Quentin Monnet <[email protected]>
joestringer
approved these changes
Aug 2, 2024
README.md
Outdated
Comment on lines
56
to
61
| Use the `release` utility to update GitHub projects and create release notes | ||
| for a new Cilium release: | ||
|
|
||
| ```bash | ||
| $ export GITHUB_TOKEN=<token_with_repo_public_access> | ||
| ``` |
There was a problem hiding this comment.
side-note, after #229 we no longer need to export this token.
Following commit b482702 ("pkg/github: Auto-populate GITHUB_TOKEN"), the tool no longer requires the GitHub token to be set explicitly by the user. Instead, it is able to rely on the GitHub command line to automatically fetch and use the relevant token. Let's remove the token-definition step from the instructions. Suggested-by: Joe Stringer <[email protected]> Signed-off-by: Quentin Monnet <[email protected]>
|
Good catch, I added a commit to remove this instruction. Thank you! |
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.