Skip to content

Commit

Permalink
step 1
Browse files Browse the repository at this point in the history
  • Loading branch information
hsubox76 committed Feb 13, 2023
1 parent c36f3ab commit 833a105
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/check-docs.yml
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."

0 comments on commit 833a105

Please sign in to comment.