51 lines
2.2 KiB
YAML
51 lines
2.2 KiB
YAML
name: Hubber contribution help
|
||
|
||
# **What it does**: When a PR is opened by a non-Docs team Hubber, adds a bot comment with helpful links
|
||
# **Why we have it**: To help non–Docs Hubbers navigate how to get a PR reviewed by the Docs team
|
||
# **Who does it impact**: docs-internal contributors
|
||
|
||
on:
|
||
pull_request_target:
|
||
types:
|
||
- opened
|
||
paths:
|
||
- 'content/**'
|
||
- 'data/**'
|
||
|
||
permissions:
|
||
pull-requests: write
|
||
|
||
jobs:
|
||
check-team-membership:
|
||
if: github.repository == 'github/docs-internal' && github.actor != 'github-openapi-bot'
|
||
runs-on: ubuntu-latest
|
||
steps:
|
||
- id: membership_check
|
||
uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975
|
||
with:
|
||
github-token: ${{ secrets.DOCS_BOT_PAT_WORKFLOW_READORG }}
|
||
script: |
|
||
try {
|
||
await github.rest.teams.getMembershipForUserInOrg({
|
||
org: 'github',
|
||
team_slug: 'docs',
|
||
username: context.payload.sender.login,
|
||
});
|
||
return true
|
||
} catch(err) {
|
||
return false
|
||
}
|
||
|
||
- name: Comment on the PR
|
||
if: steps.membership_check.outputs.result == 'false'
|
||
run: |
|
||
gh pr comment $PR --body "Thanks so much for opening this PR and contributing to GitHub Docs!
|
||
|
||
- When you're ready for the Docs team to review this PR, add the *ready-for-doc-review* label to your PR, and it will be automatically added to the [Docs Content review board](https://github.com/orgs/github/memexes/901?layout=table&groupedBy%5BcolumnId%5D=11024). **Please factor in at least 72 hours for a review, even longer if this is a substantial change.**
|
||
- If you're adding a release note, request a technical review. The Docs team will review the PR after the technical review is complete.
|
||
- If your updates to the docs are more than a simple fix, you might want to go back and open an [issue](https://github.com/github/docs-content/issues/new/choose) to ensure we've covered all areas of the docs in these updates. Not doing so may result in delays or inaccurate documentation."
|
||
|
||
env:
|
||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||
PR: ${{ github.event.pull_request.html_url }}
|