1
0
mirror of synced 2026-01-30 15:01:41 -05:00

Part 1 of 2: publicize docs fundamentals, simplify self-review checklist and pull request template (#52624)

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Hector Alfaro <hectorsector@github.com>
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
This commit is contained in:
Joe Clark
2024-11-25 10:45:50 -08:00
committed by GitHub
parent 40bbab639b
commit f07eebbdb1
9 changed files with 46 additions and 88 deletions

View File

@@ -1,39 +0,0 @@
name: Add review template
# **What it does**: When a specific label is added to a PR, adds the contents of .github/review-template.md as a comment in the PR
# **Why we have it**: To help Docs Content team members ensure that their PR is ready for review
# **Who does it impact**: docs-internal maintainers and contributors
on:
pull_request:
types:
- labeled
permissions:
contents: read
jobs:
comment-that-approved:
name: Add review template
runs-on: ubuntu-latest
if: github.event.label.name == 'add-review-template' && github.repository == 'github/docs-internal'
steps:
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
# Jump through some hoops to work with a multi-line file
- name: Store review template in variable
run: |
TEMPLATE=$(cat .github/review-template.md)
echo "TEMPLATE<<EOF" >> $GITHUB_ENV
echo "$TEMPLATE" >> $GITHUB_ENV
echo "EOF" >> $GITHUB_ENV
- name: Comment on the PR
run: |
gh pr comment $PR --body "$TEMPLATE"
env:
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_WORKFLOW_READORG }}
PR: ${{ github.event.pull_request.html_url }}
TEMPLATE: ${{ env.TEMPLATE }}

View File

@@ -25,7 +25,7 @@ jobs:
with:
issue-number: ${{ github.event.pull_request.number }}
body: |
Thank you for updating our GitHub Enterprise Server release notes. A member of the `docs-content-enterprise` team will review your changes.
Thank you for updating our GitHub Enterprise Server release notes. Please request a technical review for your changes. Once the technical review is complete, a member of the `docs-content-enterprise` team will review your changes.
- If the change is urgent, post in `#docs-content-enterprise` on Slack.
- Review the [style guide for release notes](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide#release-notes).

View File

@@ -44,11 +44,11 @@ jobs:
- 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!
gh pr comment $PR --body "### Next: add the review label
- 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."
**🛎️ Is this PR ready for review?** A PR is ready for a docs review _after_ the self-review checklist is complete.
When this is ready for review, add the **\`ready-for-doc-review\`** label to this PR. The PR will then be automatically added to the [Docs Content review board](https://github.com/orgs/github/projects/2936). _Please allow at least 3 working days for a review, and longer if this is a substantial change._
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}