Actions: Add workflow to request docs review #5285
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
|
|
📚 Thanks for the docs ping! 🛎️ This was added to our docs first-responder project board. A team member will be along shortly to respond. To request changes to the docs you can also open a 
felicitymay
previously approved these changes
Mar 1, 2021
.github/workflows/docs-review.yml
Outdated
| # Run only on labelled PRs to the main repository. | ||
| # Do not run on PRs to forks. | ||
| if: | ||
| github.event.label.name == 'docs-review-required' |
There was a problem hiding this comment.
Maybe modify the label name slightly?
Suggested change
| github.event.label.name == 'docs-review-required' | |
| github.event.label.name == 'ready-for-docs-review' |
There was a problem hiding this comment.
How about ready-for-docs-review, so it's clear that your review is being requested?
When a PR is labelled with 'ready-for-docs-review', this workflow comments on the PR to notify the GitHub CodeQL docs team. Runs on `pull_request_target` events so it can write comments to the PR. Since this runs in the context of the base repo, it must not check out the PR or use untrusted data from the event payload. Only runs when the PR base is github/codeql, to prevent notifications from forks.
adityasharad
force-pushed
the
actions/docs-review
branch
from
047b41a
to
dbed4a1
Compare
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.
When a PR is labelled with
docs-review-required, this workflow comments on the PR to notify the GitHub CodeQL docs team.Runs on
pull_request_targetevents so it can write comments to the PR.Since this runs in the context of the base repo, it must not check out the PR or use untrusted data from the event payload.
Only runs when the PR base is
github/codeql, to prevent notifications from forks.@github/docs-content-codeql does this work for your needs?