Skip to content

Commit 1ad52b6

Browse files
chore: update copilot-instructions.md (#159)
* chore: update .github/copilot-instructions.md * chore: update .github/copilot-instructions.md --------- Co-authored-by: joshjohanning-repo-settings-sync[bot] <237077283+joshjohanning-repo-settings-sync[bot]@users.noreply.github.com>
1 parent d3c6280 commit 1ad52b6

1 file changed

Lines changed: 15 additions & 4 deletions

File tree

.github/copilot-instructions.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,11 @@ const { functionToTest } = await import('../src/index.js');
5757

5858
## GitHub Actions Patterns
5959

60+
### Node Runtime
61+
62+
- Use the same Node.js runtime version configured in this repo's `action.yml` (currently `node20`) for `runs.using`
63+
- When updating Node.js support, update `runs.using` in `action.yml`, the `engines.node` range in `package.json`, and CI/test matrices together to stay consistent
64+
6065
### Input Handling
6166

6267
- Use our custom `getInput()` function for reliable local/CI compatibility
@@ -96,14 +101,20 @@ const { functionToTest } = await import('../src/index.js');
96101

97102
- Use `npm run package` to bundle with ncc
98103
- Don't commit the bundled `dist/` directory (during publishing this gets published to **tag-only**)
99-
- Run `npm run all` before committing (format, lint, test, package)
104+
- Run `npm run all` before committing (format, lint, test, package, and badge updating)
105+
106+
### Dependency and Version Changes
107+
108+
- When bumping versions or changing dependencies, run `npm install` first to sync the `package-lock.json`, then run `npm run all`
109+
- Do not skip these steps -- a mismatched `package-lock.json` or failing checks will break CI
100110

101111
## Documentation Standards
102112

103-
### README Updates
113+
### README and action.yml Updates
104114

105-
- Keep usage examples up to date with `action.yml`
106-
- Document all inputs and outputs
115+
- **Always update `README.md` and `action.yml` when adding, removing, or changing inputs, outputs, or behavior** -- do not forget this step
116+
- Keep usage examples in the README in sync with `action.yml`
117+
- Document all inputs and outputs in both `action.yml` (descriptions/defaults) and `README.md` (usage table/examples)
107118
- Include local development instructions
108119
- Update feature lists when adding functionality
109120

0 commit comments

Comments
 (0)