From 9ed2061cc0d905858e532af0401ec4236418e4ef Mon Sep 17 00:00:00 2001 From: Garret Patten Date: Fri, 15 May 2026 18:42:58 -0400 Subject: [PATCH 1/3] add AGENTS.md --- AGENTS.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..0481c60a --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,51 @@ +# Agent instructions + +This repository is a GitHub Action (TypeScript → `ncc` bundle in `dist/`). Treat **[CONTRIBUTING.md](./CONTRIBUTING.md)** as the source of truth for releases and when to rebuild `dist/`. + +## Before you finish a change + +Do **not** consider work complete until local checks pass with **no errors**. Run everything below from the repository root (after `npm ci` if dependencies may be stale). + +### Linters (required) + +These mirror [.github/workflows/quality-checks.yaml](./.github/workflows/quality-checks.yaml) (`markdownlint`, Prettier, `yamllint`): + +| Command | Purpose | +| ----------------------- | ------------------------------------------------------------------------------------------------------------------ | +| `npm run lint:prettier` | Prettier (`prettier --check .`) | +| `npm run lint:md` | Markdown ([markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2), config: `.markdownlint-cli2.yaml`) | +| `npm run lint:yaml` | YAML ([yamllint](https://yamllint.readthedocs.io/), config: `.yamllint.yaml`) | + +If **`lint:yaml`** fails because `yamllint` is missing, install it for your environment (for example `pip install yamllint` or your OS package manager), then re-run. + +**Fix failures instead of ignoring them** when practical: + +- Prettier: `npx prettier --write .` (or fix only touched paths), then re-run `npm run lint:prettier`. +- Markdown/YAML: correct the files per rule messages; re-run until clean. + +### TypeScript + +| Command | When | +| ------------------- | --------------------------------------------------- | +| `npm run typecheck` | Whenever `src/`, `tsconfig.json`, or typings change | + +### Tests + +| Command | When | +| ---------- | ---------------------------------------------- | +| `npm test` | Whenever behavior under `src/` or tests change | + +### Build artifact + +| Command | When | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `npm run build` | Whenever TypeScript under `src/` changes—updates `dist/index.js`; commit the bundle per [CONTRIBUTING.md](./CONTRIBUTING.md). | + +## Quick verification checklist + +1. `npm run lint:prettier && npm run lint:md && npm run lint:yaml` +2. `npm run typecheck` +3. `npm test` +4. If `src/` changed: `npm run build` and include `dist/` updates if required by contributing guidelines + +Resolve every failure before handing off or summarizing the task as done. From 9e87dd8403cf1f2bef495f873db1894dd33bd42a Mon Sep 17 00:00:00 2001 From: Garret Patten Date: Fri, 15 May 2026 18:45:24 -0400 Subject: [PATCH 2/3] fix: remove version pin --- .github/workflows/codeowner-verifier.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/codeowner-verifier.yaml b/.github/workflows/codeowner-verifier.yaml index 48eceed9..20061319 100644 --- a/.github/workflows/codeowner-verifier.yaml +++ b/.github/workflows/codeowner-verifier.yaml @@ -85,7 +85,7 @@ jobs: if: steps.filelists.outputs.skip_verify != 'true' continue-on-error: true id: codeowner-verifier - uses: garretpatten/codeowner-verifier@v2 + uses: garretpatten/codeowner-verifier with: changedFiles: ${{ steps.filelists.outputs.git_diff }} deletedFiles: ${{ steps.filelists.outputs.git_diff_deleted }} From 378166cb7c9b8625dcac4b8d8b3f8ccc2f1c06b7 Mon Sep 17 00:00:00 2001 From: Garret Patten Date: Fri, 15 May 2026 18:48:21 -0400 Subject: [PATCH 3/3] fix: pin to master --- .github/workflows/codeowner-verifier.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/codeowner-verifier.yaml b/.github/workflows/codeowner-verifier.yaml index 20061319..b533321b 100644 --- a/.github/workflows/codeowner-verifier.yaml +++ b/.github/workflows/codeowner-verifier.yaml @@ -85,7 +85,7 @@ jobs: if: steps.filelists.outputs.skip_verify != 'true' continue-on-error: true id: codeowner-verifier - uses: garretpatten/codeowner-verifier + uses: garretpatten/codeowner-verifier@master with: changedFiles: ${{ steps.filelists.outputs.git_diff }} deletedFiles: ${{ steps.filelists.outputs.git_diff_deleted }}