You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/workflows/check-docs.yml
+31-23
Original file line number
Diff line number
Diff line change
@@ -22,26 +22,34 @@ jobs:
22
22
runs-on: ubuntu-latest
23
23
24
24
steps:
25
-
- name: Checkout Repo
26
-
uses: actions/checkout@v4
27
-
with:
28
-
# get all history for the diff
29
-
fetch-depth: 0
30
-
- name: Set up Node (20)
31
-
uses: actions/setup-node@v3
32
-
with:
33
-
node-version: 22.10.0
34
-
- name: Yarn install
35
-
run: yarn
36
-
- name: Run doc generation
37
-
run: yarn docgen:all
38
-
- name: Check for changes in docs-devsite dir (fail if so)
39
-
run: |
40
-
if [[ -n "$(git status docs-devsite --porcelain)" ]]; then
41
-
echo "Unstaged changes detected:"
42
-
git status -s
43
-
exit 1
44
-
fi
45
-
- name: Reference documentation needs to be updated. See message below.
46
-
if: ${{ failure() }}
47
-
run: echo "Changes in this PR affect the reference docs. Run \`yarn docgen:all\` locally to regenerate docs and add them to this PR."
25
+
- name: Checkout Repo
26
+
uses: actions/checkout@v4
27
+
with:
28
+
# get all history for the diff
29
+
fetch-depth: 0
30
+
- name: Set up Node (20)
31
+
uses: actions/setup-node@v4
32
+
with:
33
+
node-version: 22.10.0
34
+
- name: Yarn install
35
+
run: yarn
36
+
- name: Run doc generation
37
+
run: yarn docgen:all
38
+
# Fail first if there are docs-devsite changes since running yarn docgen:all
39
+
# will also regenerate any API report changes.
40
+
- name: Check for changes in docs-devsite dir (fail if so)
41
+
run: |
42
+
if [[ -n "$(git status docs-devsite --porcelain)" ]]; then
43
+
echo "Unstaged changes detected in docs-devsite/:"
44
+
git status -s
45
+
echo "Changes in this PR affect the reference docs or API reports. Run \`yarn docgen:all\` locally to regenerate the changed files and add them to this PR."
46
+
exit 1
47
+
fi
48
+
- name: Check for changes in common/api-review dir (fail if so)
49
+
run: |
50
+
if [[ -n "$(git status common/api-review --porcelain)" ]]; then
51
+
echo "Unstaged changes detected in api-report(s):"
52
+
git status -s
53
+
echo "Changes in this PR affect the API reports. Run \`yarn build\` locally to regenerate the API reports and add them to this PR."
0 commit comments