Update site-policy-reminder action to include info about syncing and merging PRs (#30809)
This commit is contained in:
8
.github/workflows/site-policy-reminder.yml
vendored
8
.github/workflows/site-policy-reminder.yml
vendored
@@ -1,8 +1,8 @@
|
||||
name: Site Policy Reminder
|
||||
|
||||
# **What it does**: Automated comment reminder on a PR to change the title for public consumption before merging
|
||||
# **Why we have it**: Titles of merged PRs to Site Policies are sent to the public site-policy repo
|
||||
# **Who does it impact**: Docs team merging changes to Site Policies
|
||||
# **What it does**: Automated comment reminder on a PR to change the title for public consumption before merging and to run the Site Policy repo sync action
|
||||
# **Why we have it**: Titles of merged PRs to Site Policies are sent to the public site-policy repo when the repos are synced
|
||||
# **Who does it impact**: Everyone merging changes to Site Policies
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
@@ -26,3 +26,5 @@ jobs:
|
||||
issue-number: ${{ github.event.pull_request.number }}
|
||||
body: |
|
||||
Before merging, please remember to change the title of this PR to a description of its changes that is suitable for public viewing on github/site-policy.
|
||||
|
||||
<@github/site-policy-admins>, when these changes are ready to be synced to the site policy repo for the 24-hour or 30-day [review window](https://github.com/github/site-policy#whats-the-process), run the [site policy sync action](https://github.com/github/docs-internal/actions/workflows/site-policy-sync.yml) from this PR's branch. When these changes are ready to be merged in `docs-internal`, let the Docs team know on Slack in #docs-content and a writer will merge this PR.
|
||||
|
||||
Reference in New Issue
Block a user