-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
dev: add action to add checklist for new linter #4855
Conversation
7d884ce
to
7e3919a
Compare
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.
I'm not a fan of labeled
events with an if
because the workflow will be triggered for all the labeled
events and will create "noise" inside the GitHub action tab.
Sadly, it's not possible to define the type inside the on
section.
This is the main reason why I never created this workflow.
An alternative is to use workflow_dispatch
.
Makes sense! I can address your concern about the markdown file but if you don't think this is useful I think we can close it instead. Didn't know you considered it and opted not to do it.
Yeah maybe, it would add the list to the repo but would require a manual invocation so not sure if it's useful. I also don't know how to target a specific PR from a |
The best solution (if we except a better labeling event management) is to have "saved replies" by repository or organization, but GitHub doesn't seem to plan to add this feature:
At least the checklist template will be available for all the maintainers. |
I modified your PR to use FYI, I tested the workflow with a testing repo (ldez/redesignedwaffle#2) |
Nice! Never used Since 100% of the uses of this checklist have been from you so far feel free to decide if you want this as an action or keep doing it the old style! If the latter just close this PR! Another goal with the action was to add the comment as soon as possible without human interaction for the author of the PR to quickly see what's expected when adding a new linter. That won't be the case now so maybe just more work for you to trigger the workflow. 😕 |
The approach allows sharing the comment content with all maintainers, it's positive. Currently, I will still use my "Saved Reply" in most cases because it's easier for me, but I will migrate to the workflow dispatch. |
This will add the checklist for new linters to the repository and revision control. When the label `linter: new` is added the checklist will automatically be added to the PR instead of having to copy-paste it from an arbitrary source. Since only collaborators and members can add labels it's not likely that this will be abused, however to mitigate the risk even further the action will reset the checklist comment if the tag is added and removed multiple times.
7e7e404
to
7d982df
Compare
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.
LGTM
This will add the checklist for new linters to the repository and revision control. When the label
linter: new
is added the checklist will automatically be added to the PR instead of having to copy-paste it from an arbitrary source.Since only collaborators and members can add labels it's not likely that this will be abused, however to mitigate the risk even further the action will reset the checklist comment if the tag is added and removed multiple times.