feat: add commit comment support (#163)

Author: mshick

.github/workflows/check-dist.yml

@@ -1,4 +1,4 @@
-name: Check Transpiled JavaScript
+name: Check dist
 
 on:
   pull_request:
@@ -12,8 +12,8 @@ permissions:
   contents: read
 
 jobs:
-  check-dist:
-    name: Check dist/
+  run:
+    name: Run
     runs-on: ubuntu-latest
 
     steps:
@@ -43,9 +43,9 @@ jobs:
             ls -la ./
             exit 1
           fi
-          if [ "$(git diff --ignore-space-at-eol --text dist/ | wc -l)" -gt "0" ]; then
+          if [ "$(git diff --ignore-space-at-eol --text dist/index.js | wc -l)" -gt "0" ]; then
             echo "Detected uncommitted changes after build. See status below:"
-            git diff --ignore-space-at-eol --text dist/
+            git diff --ignore-space-at-eol --text dist/index.js
             exit 1
           fi
 

.github/workflows/ci.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
         with:
-          node-version-file: '.node-version'
+          node-version-file: ".node-version"
 
       - name: Install Dependencies
         run: |
@@ -51,7 +51,7 @@ jobs:
     name: Dogfood
     runs-on: ubuntu-latest
     permissions:
-      contents: read
+      contents: write
       pull-requests: write
     steps:
       - name: Checkout Repo
@@ -60,7 +60,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
         with:
-          node-version-file: '.node-version'
+          node-version-file: ".node-version"
 
       - name: Install Dependencies
         run: |
@@ -94,3 +94,20 @@ jobs:
           replace: |
             Goodnight
             🌕
+
+      - name: Check for dogfood commit
+        id: dogfood-check
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          MSG=$(gh api repos/${{ github.repository }}/commits/${{ github.event.pull_request.head.sha }} --jq '.commit.message | split("\n") | .[0]')
+          if [[ "$MSG" == dogfood:* ]]; then
+            echo "match=true" >> "$GITHUB_OUTPUT"
+          fi
+
+      - uses: ./
+        if: steps.dogfood-check.outputs.match == 'true'
+        with:
+          comment-target: commit
+          commit-sha: ${{ github.event.pull_request.head.sha }}
+          message: 'ruff 🐶'

.gitignore

@@ -1,13 +1,7 @@
-
-# Ignore test runner output
-__tests__/runner/*
-!__tests__/runner/.gitkeep
-
 node_modules/
 
 # Editors
 .vscode
-.idea/**
 
 # Logs
 logs
@@ -22,56 +16,23 @@ pids
 *.seed
 *.pid.lock
 
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
 # Coverage directory used by tools like istanbul
 coverage
 
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Other Dependency directories
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
 # Optional npm cache directory
 .npm
 
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
 # Output of 'npm pack'
 *.tgz
 
-# Yarn Integrity file
-.yarn-integrity
-
 # dotenv environment variables file
-.env
-
-# next.js build output
-.next
+.env*.local
 
 # Build intermediate output
 lib/
 
 # Git worktrees
 .worktrees/
+
+# Claude's Plans
+docs/plans/

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing
+
+Thanks for your interest in contributing to Add PR Comment!
+
+## Getting Started
+
+1. Fork the repository and clone your fork
+2. Install dependencies: `npm ci`
+3. Create a feature branch: `git checkout -b feat/my-feature`
+
+## Development
+
+- `npm test` — run tests
+- `npm run check` — lint and format check
+- `npm run build` — bundle into `dist/index.js`
+
+## Submitting Changes
+
+1. Make sure tests pass and lint is clean
+2. Use [conventional commits](https://www.conventionalcommits.org/) for your PR title and first commit (e.g., `feat:`, `fix:`, `docs:`)
+3. Open a pull request against `main`
+
+## Code Style
+
+This project uses [Biome](https://biomejs.dev/) for linting and formatting. Run `npm run format` to auto-fix issues.
+
+## Reporting Issues
+
+Please open an issue on GitHub with a clear description and, if possible, a minimal reproduction.

action.yml

@@ -1,5 +1,5 @@
 name: 'Add PR Comment'
-description: 'Add a comment to a pull request'
+description: 'Add a comment to a pull request or commit'
 inputs:
   message:
     description: 'The message to print.'
@@ -59,6 +59,13 @@ inputs:
   preformatted:
     description: 'Treat message text (from a file or input) as pre-formatted and place it in a codeblock.'
     required: false
+  comment-target:
+    description: 'Where to post the comment. Use "pr" for pull request/issue comments (default) or "commit" for commit comments.'
+    default: 'pr'
+    required: false
+  commit-sha:
+    description: 'The commit SHA to comment on when comment-target is "commit". Defaults to the current commit.'
+    required: false
   find:
     description: 'A regular expression to find for replacement. Multiple lines become individual regular expressions.'
   replace: