Skip to content

Commit 0f6ec07

Browse files
authored
docs: replace copilot instructions with AGENTS.md (#794)
## Summary - replace the root `AGENTS.md` symlink with a real file - move the agent instructions out of `.github/copilot-instructions.md` into `AGENTS.md` - trim the content down to concise, repo-specific guidance and add a short repository orientation ## Testing - not run (docs-only change)
1 parent 821e5c9 commit 0f6ec07

File tree

2 files changed

+13
-264
lines changed

2 files changed

+13
-264
lines changed

.github/copilot-instructions.md

Lines changed: 0 additions & 263 deletions
This file was deleted.

AGENTS.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

AGENTS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# setup-uv agent notes
2+
3+
This repository is a TypeScript-based GitHub Action for installing `uv` in GitHub Actions workflows. It also supports restoring/saving the `uv` cache and optional managed-Python caching.
4+
5+
- The published action runs the committed bundles in `dist/`, not the TypeScript in `src/`. After any code change, run `npm run package` and commit the resulting `dist/` updates.
6+
- Standard local validation is:
7+
1. `npm ci --ignore-scripts`
8+
2. `npm run all`
9+
- `npm run check` uses Biome (not ESLint/Prettier) and rewrites files in place.
10+
- User-facing changes are usually multi-file changes. If you add or change inputs, outputs, or behavior, update `action.yml`, the implementation in `src/`, tests in `__tests__/`, relevant docs/README, and then re-package.
11+
- The easiest areas to regress are version resolution and caching. When touching them, add or update tests for precedence, cache invalidation, and cross-platform path behavior.
12+
- Workflow edits have extra CI-only checks (`actionlint` and `zizmor`); `npm run all` does not cover them.
13+
- Before finishing, make sure validation does not leave generated or formatting-only diffs behind.

0 commit comments

Comments
 (0)