-
Notifications
You must be signed in to change notification settings - Fork 888
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
name: Doc Change Check (Run yarn format locally if this fails) | ||
|
||
on: pull_request | ||
|
||
jobs: | ||
doc-check: | ||
name: Check if reference docs have changed | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout Repo | ||
uses: actions/checkout@master | ||
with: | ||
# get all history for the diff | ||
fetch-depth: 0 | ||
- name: Set up Node (14) | ||
uses: actions/setup-node@v2 | ||
with: | ||
node-version: 14.x | ||
- name: Yarn install | ||
run: yarn | ||
- name: Run doc generation (devsite docs) | ||
run: yarn docgen devsite | ||
- name: Check for changes (fail if so) | ||
run: | | ||
cd docs-devsite | ||
git diff --exit-code | ||
- name: Reference documentation needs to be updated. See message below. | ||
if: ${{ failure() }} | ||
run: echo "Changes in this PR affect the reference docs. Run \`yarn docgen\` locally to regenerate docs and add them to this PR." |