Skip to content
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

improve prdoc generation #5931

Merged
merged 8 commits into from
Oct 8, 2024
Merged

improve prdoc generation #5931

merged 8 commits into from
Oct 8, 2024

Conversation

mordamax
Copy link
Contributor

@mordamax mordamax commented Oct 4, 2024

Related to #5924 (comment)

improve prdoc arguments validation & help:

image

Test evidence: paritytech-stg@6dd274e

@mordamax mordamax requested review from a team as code owners October 4, 2024 15:37
@mordamax mordamax changed the title fix regex, improve prdoc generation inputs improve prdoc generation Oct 4, 2024

parser.add_argument("--pr", type=int, required=pr_required, help="The PR number to generate the PrDoc for.")
parser.add_argument("--audience", type=str, nargs='*', choices=allowed_audiences, default=["todo"], help="The audience of whom the changes may concern. Example: --audience runtime_dev node_dev")
parser.add_argument("--bump", type=str, default="major", choices=["patch", "minor", "major", "silent", "ignore", "no_change"], help="A default bump level for all crates. Example: --bump patch")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be nice if this could be taken from the CI check. Aka to take the bump as determined by the tool.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, i also thought about it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think i'll try to do this within paritytech/prdoc#46

docs/contributor/commands-readme.md Outdated Show resolved Hide resolved
@mordamax mordamax requested a review from bkchr October 7, 2024 16:01
@mordamax mordamax added the R0-silent Changes should not be mentioned in any release notes label Oct 7, 2024
@bkchr bkchr enabled auto-merge October 7, 2024 20:50
@bkchr bkchr added this pull request to the merge queue Oct 8, 2024
Merged via the queue into master with commit 4b40e76 Oct 8, 2024
240 of 243 checks passed
@bkchr bkchr deleted the mak-fix-cmd-regex branch October 8, 2024 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R0-silent Changes should not be mentioned in any release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

/cmd prdoc fails parsing arguments with quotes
5 participants