-
Notifications
You must be signed in to change notification settings - Fork 193
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
Add new subcommands to changelogger
for supporting file-per-change changelog
#3771
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
A new generated diff is ready to view.
A new doc preview is ready to view. |
Velfi
reviewed
Jul 19, 2024
Velfi
approved these changes
Jul 19, 2024
landonxjames
approved these changes
Jul 19, 2024
This commit addresses #3771 (comment)
A new generated diff is ready to view.
A new doc preview is ready to view. |
aajtodd
approved these changes
Jul 22, 2024
drganjoo
approved these changes
Jul 31, 2024
This commit addresses #3771 (comment)
This commit addresses #3771 (comment)
This commit addresses #3771 (comment)
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.
Motivation and Context
Adds new subcommands
--new
and--ls
tochangelogger
Description
This is part 2 in a series of PRs supporting file-per-change changelog. This PR just adds utilities for humans and does NOT impact the current dev workflow, smithy-rs CI, or our release pipeline.
A subcommand
--new
We can use this subcommand when creating a new changelog entry markdown file. An example usage:
The following CLI arguments are "logically" required
--applies-to
--ref
--author
--message
If any of the above is not passed a value at command line, then an editor is opened for further edit (which editor to open can be configured per the edit crate).
Note that the YAML syntax above is different from the single line array syntax proposed in the RFC. This is due to a limitation in
serde-yaml
(which has been archived unfortunately), but the multi-line values are still a valid YAML syntax and, most importantly, rendering changelong entries will continue working. For now, I won't post-process from the multi-line values syntax to the single line array syntax. One can work around this by handwriting a changelog entry Markdown file insmithy-rs/.changelog
without using this subcommand.A subcommand
--ls
This subcommand will render a preview of changelog entries stored in
smithy-rs/.changelog
and print it to the standard output. Example usages (using the entry created at 5745197.md above):Testing
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.