Add a roadmap auto commenter for use by all repositories#11
Open
Exairnous wants to merge 2 commits into
Open
Conversation
What: adds a workflow that will leave a comment on newly opened issues and pull requests about the roadmap status (i.e. that it isn't on any roadmap yet) of that issue/pull request that can be called by any Hubs Foundation repository. Why: so that people will know what to expect and so that someone doesn't have to manually respond to new issues/pull requests with a stock reply. Also, it's added as a reusable workflow so that changes to the comments or behaviour only have to be made to this workflow, rather than the workflow in every repository. Note: this won't add a comment if it finds a roadmap label has been added to the issue/pull request during creation.
Exairnous
force-pushed
the
reusable-roadmap-auto-commenter
branch
from
6480128 to
2db8d78
Compare
What: modifies the check for pull requests from the `pull_request` event to the `pull_request_target` event and adds a warning comment about it. Why: the `pull_request_target` event bypasses the normal workflow approval rules of the repository and allows the auto commenter to work for pull requests made from external contributors/their forks; it is also safer because it will only run the workflow file from the Hubs Foundation, not the external contributor's pull request (which is why GitHub allows it to run automatically for everyone).
Collaborator
|
LGTM! Special thanks for the screen captures for "issue" and "pull request"-- very helpful to see! 👀 |
16 tasks
Member
Author
|
I've added a clarification about the motivation of the roadmap auto commenter to the |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What?
Adds a workflow that will leave a comment on newly opened issues and pull requests about the roadmap status (i.e. that it isn't on any roadmap yet) of that issue/pull request that can be called by any Hubs Foundation repository.
Why?
So that people will know what to expect and so that someone doesn't have to manually respond to new issues/pull requests with a stock reply. Also, it's added as a reusable workflow so that changes to the comments or behaviour only have to be made to this workflow, rather than the workflow in every repository.
Examples
Comment on a newly opened issue:
Comment on a newly opened pull request:
How to test
Roadmap: Test).Documentation of functionality
Currently, this is fully automatic with no configuration options and it is for the Hubs Foundation's use only (so not appropriate to put in the Hubs Docs). This helps to apply the roadmap policy. In light of all this, I don't think any additional documentation is needed at present.
Limitations
None known.
Alternative implementations considered
None.
Open questions
None.
Additional details or related context
This won't add a comment if it finds a roadmap label has been added to the issue/pull request during creation.
Roadmap policy PR: Hubs-Foundation/policies-procedures-guidelines-public#25
This workflow will need a caller workflow added to each repository.
Initial companion PR to call this workflow: #12
Note: this is only intended to help convey our use of roadmaps and the status of an issue/PR on them (by providing one way notifications). It is not intended for this to expand into any sort of customer service auto-responder that would reply to all comments or that could be interacted with by people.