Skip to content

Commit 833a105

Browse files
committed
step 1
1 parent c36f3ab commit 833a105

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

.github/workflows/check-docs.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Doc Change Check (Run yarn format locally if this fails)
2+
3+
on: pull_request
4+
5+
jobs:
6+
doc-check:
7+
name: Check if reference docs have changed
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- name: Checkout Repo
12+
uses: actions/checkout@master
13+
with:
14+
# get all history for the diff
15+
fetch-depth: 0
16+
- name: Set up Node (14)
17+
uses: actions/setup-node@v2
18+
with:
19+
node-version: 14.x
20+
- name: Yarn install
21+
run: yarn
22+
- name: Run doc generation (devsite docs)
23+
run: yarn docgen devsite
24+
- name: Check for changes (fail if so)
25+
run: |
26+
cd docs-devsite
27+
git diff --exit-code
28+
- name: Reference documentation needs to be updated. See message below.
29+
if: ${{ failure() }}
30+
run: echo "Changes in this PR affect the reference docs. Run \`yarn docgen\` locally to regenerate docs and add them to this PR."

0 commit comments

Comments
 (0)