agentleFS
vale-clivale-cli/agent-tools/skills/ci/SKILL.md

ci

Skill8 starsChanged 3 months agoMITView on GitHub

Run Vale in GitHub Actions, a pre-commit hook, or another runner. Use when the user says "add vale to CI", "run vale on PRs", "add a pre-commit hook", or "make the build fail on style errors".

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    If the runner has no cached StylesPath, vale sync has to run first — and that means a style updating upstream can fail a build nobody …

    line 65
  2. Very specific:

    Do not add --no-exit to make a failing job pass: If those alerts should not block, change the levels in the config, where the decision is …

    line 71

≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill 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
SKILL.md

Put Vale in the pipeline

When to use this

Vale runs locally and should now run automatically.

Prerequisites

  1. vale ls-config resolves, and a plain vale <path> run works locally. Do not wire up CI for a config that does not resolve — the failure will look like a CI problem.
  2. The user has said whether the job should block. Ask if not.

Advisory or blocking

Only error sets a non-zero exit code. Warnings and suggestions exit 0, so a job wired up naively passes no matter how much it reports.

  • Advisory — Vale reports, the job stays green. The right way to adopt Vale on a corpus that has never had it.
  • Blocking — the rules the team cares about are set to error in the config, and the job fails on those.

Say which one you are setting up, in those words. "It runs in CI" tells nobody whether it can stop a merge.

GitHub Actions

- uses: vale-cli/vale-action@reviewdog
  with:
    files: docs

Alerts arrive as review comments on the pull request, which is where a writer will see them.

pre-commit

repos:
  - repo: https://github.com/vale-cli/vale
    rev: v3.17.0
    hooks:
      - id: vale

Pin rev to a release. Hooks that float break at the worst time.

Any other runner

vale --no-global --output=line docs/

--output=line gives path:line:col:rule:message, which most CI systems can turn into annotations. --no-global keeps a config on the machine from changing the result.

If the runner has no cached StylesPath, vale sync has to run first — and that means a style updating upstream can fail a build nobody changed. Pin Packages to a release URL rather than a moving reference.

Do not

  • Do not add --no-exit to make a failing job pass. If those alerts should not block, change the levels in the config, where the decision is visible to the team.
  • Do not raise MinAlertLevel in CI only. A config that reports different things locally and in CI is how people stop trusting the tool.

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.