Skip to content
Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

365 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Amiss

version license scorecard

Amiss checks documentation against the tree it describes. It reads the documents in a repository, follows the references they make into that same repository, and reports when a reference stops resolving, or when the file behind it changed while the prose around it did not. It reads structure, not meaning: it will not tell you whether a sentence is true, and it does not guess.

The scanner engine keeps no state, executes nothing, never touches the network, and never writes; identical inputs through the same engine binary produce byte-identical reports. A reference that does not resolve fails the run under enforce; a file changing under an unchanged paragraph is always a signal for a human, never a machine verdict.

cargo install amiss

amiss check --repo . --object-format sha1 \
    --base "$(git rev-parse HEAD~1)" --candidate "$(git rev-parse HEAD)" \
    --profile observe

In CI the same engine ships as an action that derives both commits from the event. It groups related findings by target, shows Fixes before Checks, and annotates only Fixes introduced by the pull request:

- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
  with:
    fetch-depth: 2
- uses: HardMax71/amiss@v0
  with:
    profile: observe

Start in observe so Fixes can be triaged without blocking pull requests; Existing problems stay in the report, Checks stay in the summary, and an incomplete or untrusted run still fails. Switch the input to enforce once the initial backlog and repository policy have been reviewed.

Coding agents get the same treatment as people: every finding and error row carries a sentence saying what it means and what to do, a rejected invocation prints the whole grammar, and the book's Working with agents chapter has a paste block for your repository's AGENTS.md. The book is one fetch at llms.txt, or in full at llms-full.txt.

Everything else is in the documentation. Distribution terms and third-party attributions are in the license and notices.

Releases

Packages

Used by

Contributors

Languages