Merge pull request #11 from imjasonh/fix-dist-folder

Fix critical issue: commit dist/index.js

Author: imjasonh

.github/workflows/ci.yml

@@ -7,45 +7,99 @@ on:
     branches: [main]
 
 permissions:
-  contents: read
+  contents: write
+  pull-requests: write
 
 jobs:
-  pre-commit:
+  check-dist:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          # Use a token that can push for PR events from same repo
+          token: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository && secrets.GITHUB_TOKEN || github.token }}
+          ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.ref || github.ref }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .node-version
+          cache: npm
+      - run: npm ci
+      - run: npm run build
+      - id: check-changes
+        run: |
+          if [ -n "$(git status --porcelain dist/)" ]; then
+            echo "changes=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "changes=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      # For push events, just fail if out of date
+      - name: Fail if dist is out of date (push)
+        if: github.event_name == 'push' && steps.check-changes.outputs.changes == 'true'
+        run: |
+          echo "Detected uncommitted changes after build. See diff below:"
+          git diff --ignore-space-at-eol --text dist/
+          echo ""
+          echo "Please run 'npm run build' locally and commit the changes."
+          exit 1
+
+      # For PRs from same repo, update automatically
+      - name: Update dist (PR)
+        if: |
+          github.event_name == 'pull_request' &&
+          steps.check-changes.outputs.changes == 'true' &&
+          github.event.pull_request.head.repo.full_name == github.repository
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add dist/
+          git commit -m "chore: update dist" --no-verify
+          git push
+          echo ""
+          echo "✅ Updated dist/ directory. The check-dist job will pass on the next CI run."
+          echo ""
+          exit 1  # Fail to prevent auto-merge of out-of-date dist
+
+      # For PRs from forks, fail with instructions
+      - name: Fail if dist is out of date (fork PR)
+        if: |
+          github.event_name == 'pull_request' &&
+          steps.check-changes.outputs.changes == 'true' &&
+          github.event.pull_request.head.repo.full_name != github.repository
+        run: |
+          echo "Detected uncommitted changes after build. See diff below:"
+          git diff --ignore-space-at-eol --text dist/
+          echo ""
+          echo "This PR is from a fork. Please run 'npm run build' locally and commit the changes."
+          exit 1
 
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
           python-version: '3.x'
-
       - uses: actions/setup-node@v4
         with:
           node-version: '20'
           cache: 'npm'
-
-      - name: Install dependencies
-        run: npm ci
-
+      - run: npm ci
       - uses: pre-commit/[email protected]
 
   # Test the action itself
   test-action:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-
       - uses: actions/setup-go@v5
         with:
           go-version: 'stable'
-
       - uses: actions/setup-node@v4
         with:
           node-version: '20'
-
-      # Build the action
-      - name: Build action
-        run: |
+      - run: |
           npm ci
           npm run build
 

.gitignore

@@ -5,7 +5,7 @@ yarn-debug.log*
 yarn-error.log*
 
 # Build output
-dist/
+# dist/ is intentionally committed for GitHub Actions
 
 # Test coverage
 coverage/

.node-version

@@ -0,0 +1 @@
+20.9.0

.nvmrc

@@ -0,0 +1 @@
+20.9.0

.pre-commit-config.yaml

@@ -3,9 +3,12 @@ repos:
     rev: v4.5.0
     hooks:
       - id: trailing-whitespace
+        exclude: ^dist/
       - id: end-of-file-fixer
+        exclude: ^dist/
       - id: check-yaml
       - id: check-added-large-files
+        exclude: ^dist/
       - id: check-json
       - id: pretty-format-json
         args: ['--autofix']
@@ -15,25 +18,12 @@ repos:
     rev: v3.1.0
     hooks:
       - id: prettier
+        exclude: ^(dist/|.*\.md$)
 
   - repo: https://github.com/pre-commit/mirrors-eslint
     rev: v8.56.0
     hooks:
       - id: eslint
         files: \.js$
         args: ['--fix']
-
-  - repo: local
-    hooks:
-      - id: build-dist
-        name: Build dist
-        entry: npm run build
-        language: system
-        pass_filenames: false
-        files: ^(index\.js|lib/.*\.js)$
-      - id: check-dist
-        name: Check dist is up to date
-        entry: bash -c 'if [ -n "$(git status --porcelain dist)" ]; then echo "dist is out of date. Run npm run build and commit the changes."; exit 1; fi'
-        language: system
-        pass_filenames: false
-        always_run: true
+        exclude: ^dist/

CLAUDE.md

@@ -10,6 +10,8 @@ This is a GitHub Action written in Node.js that detects breaking API changes in
 
 ### Development
 
+**Important**: Use Node.js v20 to match GitHub Actions runtime.
+
 ```bash
 # Install dependencies
 npm ci
@@ -47,21 +49,18 @@ INPUT_OLD=HEAD~1 INPUT_NEW=HEAD node index.js
 ### Core Components
 
 1. **index.js** - Main entry point that:
-
    - Reads GitHub Action inputs
    - Determines which commits/directories to compare
    - Orchestrates the apidiff run, parsing, and PR commenting
    - Sets action outputs
 
 2. **lib/apidiff.js** - Handles running the official apidiff tool:
-
    - Installs `golang.org/x/exp/cmd/apidiff` if not present
    - Supports both git refs and directory comparisons
    - For directories: creates export files first, then compares them
    - For git refs: runs apidiff directly on the commits
 
 3. **lib/parser.js** - Parses apidiff text output:
-
    - Extracts breaking and compatible changes by package
    - Converts to structured format
    - Generates markdown reports for PR comments
@@ -83,7 +82,33 @@ Each test case has `old/` and `new/` subdirectories with Go code.
 
 ### Build Process
 
-The action uses `@vercel/ncc` to compile all dependencies into a single `dist/index.js` file. This is required for GitHub Actions and must be committed to the repository.
+The action uses `@vercel/ncc` to compile all dependencies into a single `dist/index.js` file. This is required for GitHub Actions and must be committed to the repository. The dist/ folder is intentionally NOT in .gitignore.
+
+**Important**: The dist must be built with Node.js v20 to match GitHub Actions runtime.
+
+To build and commit dist after making changes:
+
+```bash
+# Method 1: Use the helper script
+./scripts/use-node-20.sh  # Switches to Node 20
+npm run build
+git add dist/index.js
+git commit -m "Rebuild dist"
+
+# Method 2: Manual with nvm
+nvm use  # Reads .nvmrc and switches to Node 20.9.0
+node --version  # Should show v20.x.x
+npm run build
+git add dist/index.js
+git commit -m "Rebuild dist"
+```
+
+**Important**: The pre-commit hooks will:
+1. Verify you're using Node 20 before building dist
+2. Automatically rebuild dist when source files change
+3. Prevent commits if dist is out of date
+
+If you get an error about Node version, switch to Node 20 using `nvm use` or `./scripts/use-node-20.sh`.
 
 ### Pre-commit Hooks
 

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+
+## Building the Action
+
+Before committing changes that affect the action code, you must rebuild the dist folder:
+
+```bash
+npm run build
+```
+
+This compiles all dependencies into `dist/index.js` which is what GitHub Actions actually runs.
+
+**Important**: The dist folder must be committed to the repository for the action to work.
+
+### Automatic dist updates
+
+If you forget to rebuild dist, the `update-dist` workflow will automatically update it for you on pull requests.
+
+## Node Version
+
+This project requires Node.js v20. We recommend using nvm to manage Node versions:
+
+```bash
+nvm use
+npm ci
+npm run build
+```
+
+## Testing
+
+Run tests with:
+
+```bash
+npm test
+```
+
+## Pre-commit Hooks
+
+This project uses pre-commit hooks to ensure code quality. Install them with:
+
+```bash
+pre-commit install
+```