diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml new file mode 100644 index 00000000000..f6ea11c6faf --- /dev/null +++ b/.github/workflows/check-docs.yml @@ -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." \ No newline at end of file