Repository navigation
121 lines (110 loc) · 4.97 KB
/
Copy pathreviewers-docs-engineering.yml
File metadata and controls
121 lines (110 loc) · 4.97 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
name: Add engineering PRs to review board
# Routes non-draft engineering PRs to the Docs & Blog Engineering PR Reviews board for triage.
# Labels each PR, so later pushes skip board work unless the PR reopens.
on:
pull_request:
types:
- edited
- opened
- ready_for_review
- reopened
- synchronize
paths:
- '**.ts'
- '**.tsx'
- '**.scss'
- 'src/**'
- '!src/**.json' # Skip automated pipeline data PRs.
- '!src/**.yml' # Skip automated pipeline data PRs.
- '!src/**.sha' # Skip automated pipeline data PRs.
- '.github/**'
- 'config/**'
- '.devcontainer/**'
- '**Dockerfile'
- 'package*.json'
- .github/workflows/reviewers-docs-engineering.yml
permissions:
contents: read
pull-requests: write
repository-projects: read
jobs:
reviewers-docs-engineering:
if: >-
${{ github.repository == 'github/docs-internal' &&
!github.event.pull_request.draft &&
(github.event.action == 'reopened' ||
!contains(github.event.pull_request.labels.*.name, 'reviewers-docs-engineering')) &&
!contains(github.event.pull_request.labels.*.name, 'lockfile-churn-only') &&
github.event.pull_request.head.ref != 'repo-sync' }}
runs-on: ubuntu-latest
env:
PR: ${{ github.event.pull_request.html_url }}
steps:
- name: Checkout repository
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
# Detect PRs that only change package-lock.json. Contributors often create
# cross-platform npm install churn while editing content.
# Comment with reset instructions instead of adding them to the engineering review board.
# Dependabot security updates can change only the lockfile when package.json
# does not name the transitive dependency.
# Those PRs are intentional, so reset instructions would be wrong and
# keeping them off the board would leave them without engineering triage.
- name: Detect lockfile-only churn
id: detect
env:
GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }}
PR_AUTHOR: ${{ github.event.pull_request.user.login }}
PR_NUMBER: ${{ github.event.pull_request.number }}
CHANGED_FILES: ${{ github.event.pull_request.changed_files }}
REPO: ${{ github.repository }}
run: |
if [ "$PR_AUTHOR" = "dependabot[bot]" ]; then
echo "Author is Dependabot; skipping lockfile churn detection."
echo "lockfile_only=false" >> "$GITHUB_OUTPUT"
exit 0
fi
# `gh pr diff` fails above 300 files, and `gh pr view --json files` stops at 100.
changed=$(gh api --paginate "repos/$REPO/pulls/$PR_NUMBER/files" --jq '.[].filename')
echo "Changed files:"
echo "$changed"
# The files API returns at most 3,000 files. If the list is incomplete, request review anyway.
if [ "$(echo "$changed" | grep -c .)" -lt "$CHANGED_FILES" ]; then
echo "Listed fewer files than the PR changes; skipping lockfile churn detection."
echo "lockfile_only=false" >> "$GITHUB_OUTPUT"
exit 0
fi
lockfile=$(echo "$changed" | grep -c '^package-lock\.json$' || true)
other_eng=$(echo "$changed" | grep -cE '(\.tsx?$|\.scss$|^src/|^package\.json$|^\.github/|^config/|^\.devcontainer/|Dockerfile)' || true)
if [ "$lockfile" -gt 0 ] && [ "$other_eng" -eq 0 ]; then
echo "lockfile_only=true" >> "$GITHUB_OUTPUT"
else
echo "lockfile_only=false" >> "$GITHUB_OUTPUT"
fi
- name: Comment and label lockfile-only PRs
if: steps.detect.outputs.lockfile_only == 'true'
env:
GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }}
run: |
cat > /tmp/lockfile-churn-body.md <<'EOF'
_Posted by Copilot on behalf of docs-engineering._
This PR includes `package-lock.json` changes but no engineering files. Please reset the lockfile:
```
git checkout origin/main -- package-lock.json
git commit -m "Reset package-lock.json"
git push
```
If the lockfile change is intentional, remove the `lockfile-churn-only` label and push or reopen the PR so this workflow sends it to the engineering review board.
EOF
gh pr comment "$PR" --body-file /tmp/lockfile-churn-body.md
gh pr edit "$PR" --add-label lockfile-churn-only
- name: Add PR to board and label
if: steps.detect.outputs.lockfile_only != 'true'
env:
GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }}
REPO: ${{ github.repository }}
PR_NUMBER: ${{ github.event.pull_request.number }}
uses: ./.github/actions/retry-command
with:
command: >-
gh project item-add 25672 --owner github --url "$PR" &&
gh api "repos/$REPO/issues/$PR_NUMBER/labels" -f 'labels[]=reviewers-docs-engineering' --silent