agentleFS
Sign inStart free
AstralKnown publisherastral-sh/setup-uv/AGENTS.md

setup-uv

AGENTS.md905 starsChanged 3 months agoMITView on GitHub

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.

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repositoryOne other file it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep these concerns separate when changing module formats:

    line 14
  2. Distinctive:

    Do not switch published bundles to ESM without validating the actual committed artifacts under the target Node runtime.

    line 17
  3. Distinctive:

    Before finishing, make sure validation does not leave generated or formatting-only diffs behind.

    line 18

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

setup-uv agent notes

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.

  • 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.
  • Standard local validation is:
    1. npm ci --ignore-scripts
    2. npm run all
  • npm run check uses Biome (not ESLint/Prettier) and rewrites files in place.
  • User-facing changes are usually multi-file changes. If you add or change inputs, outputs, or behavior, update action.yml, action-types.yml, the implementation in src/, tests in __tests__/, relevant docs/README, and then re-package.
  • 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.
  • Workflow edits have extra CI-only checks (actionlint and zizmor); npm run all does not cover them.
  • Source is authored with bundler-friendly TypeScript, but published action artifacts in dist/ are bundled as CommonJS for maximum GitHub Actions runtime compatibility with @actions/* dependencies.
  • Keep these concerns separate when changing module formats:
    • src/ and tests may use modern ESM-friendly TypeScript patterns.
    • dist/ should prioritize runtime reliability over format purity.
    • Do not switch published bundles to ESM without validating the actual committed artifacts under the target Node runtime.
  • Before finishing, make sure validation does not leave generated or formatting-only diffs behind.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free