check-dist.yml

# `dist/index.js` is a special file in Actions.
# When you reference an action with `uses:` in a workflow,
# `index.js` is the code that will run.
# For our project, we generate this file through a build process
# from other source files.
# We need to make sure the checked-in `index.js` actually matches what we expect it to be.
name: Check dist/

on:
    push:
        branches:
            - main
        paths-ignore:
            - "**.md"
            - "docs/**"
    pull_request:
        paths-ignore:
            - "**.md"
            - "docs/**"
    workflow_dispatch:

jobs:
    check-dist:
        runs-on: ubuntu-latest

        steps:
            - uses: actions/checkout@v3
            - name: Setup Node.js 16.x
              uses: actions/setup-node@v3
              with:
                  node-version: 16.x
            - name: Install dependencies
              run: npm ci --legacy-peer-deps
            - name: Rebuild the dist/ directory
              run: npm run build

            - name: Compare the expected and actual dist/ directories
              run: |
                  if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then
                    echo "Detected uncommitted changes after build.  See status below:"
                    git diff
                    exit 1
                  fi
              id: diff

            # If index.js was different than expected, upload the expected version as an artifact
            - uses: actions/upload-artifact@v3
              if: ${{ failure() && steps.diff.conclusion == 'failure' }}
              with:
                  name: dist
                  path: dist/