From cdde0c2a046636a80e5e56795a2c0d9442134cf2 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 20 Sep 2022 11:06:25 -0700 Subject: [PATCH] Update `site-policy-reminder` action to include info about syncing and merging PRs (#30809) --- .github/workflows/site-policy-reminder.yml | 8 +++++--- tests/meta/repository-references.js | 1 + 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/site-policy-reminder.yml b/.github/workflows/site-policy-reminder.yml index e1484c1b8d..53c8a237a0 100644 --- a/.github/workflows/site-policy-reminder.yml +++ b/.github/workflows/site-policy-reminder.yml @@ -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. diff --git a/tests/meta/repository-references.js b/tests/meta/repository-references.js index d9526f9841..76b39e0ffc 100644 --- a/tests/meta/repository-references.js +++ b/tests/meta/repository-references.js @@ -74,6 +74,7 @@ const ALLOW_DOCS_PATHS = [ '.github/review-template.md', '.github/workflows/hubber-contribution-help.yml', '.github/workflows/sync-search-indices.yml', + '.github/workflows/site-policy-reminder.yml', 'contributing/search.md', 'docs/index.yaml', 'lib/excluded-links.js',