@amykit/plugin-plan-check

The quality bar for a drafted plan: the repository's own check, run in its checkout.

A plugin for amy. It provides the plan-check port.

Install

npm install -g @amykit/plugin-plan-check

Then name it in ~/.amy/config.yaml:

workflows:
  your-profile:
    plugins:
      - "@amykit/plugin-plan-check"

Configuration

plugins:
  "@amykit/plugin-plan-check":
    commands: {"default":["sf check"]}
    defaultBranch: "main"
    timeoutMs: 600000

| Setting | Type | Required | Default | What it is | | :-- | :-- | :-- | :-- | :-- | | commands | record | no | {"default":["sf check"]} | the check commands per repository, with a default fallback. sf check is the whole quality bar in a repository that has one | | defaultBranch | string | no | main | the branch a plan branch is cut from, which is not always main | | timeoutMs | number | no | 600000 | how long one check may run before it is given up on |

Every field is checked at boot against the schema this package declares. A key that is not one of the above is a refusal naming the plugin and the key, not a setting that silently never applied.

Where the reasoning is

• Writing a plugin
• Reference: plugins
• Ports and the registry

Licence

MIT