flowpactworkflow contracts
Rules

FP810 · impact-under-declared

The changes to published workflows or actions need a bigger release than the pull request declares.

CodeNameCategoryDefault severity
FP810impact-under-declaredContracts🔴 error

Why it matters

Consumers pin a floating tag (@v1) or a version range and take every release in it. A breaking change released as a minor or patch reaches them without warning: a renamed job leaves their required status check waiting forever, a removed input fails their run.

How to fix

Declare the required impact (for example retitle the pull request feat!: … for a major release), or keep the published interface and check names compatible.

Example

# PR title: "fix: tidy the test job"
jobs:
  test:
    name: Unit tests   # was "Test": consumers' required check "… / Test" never reports

Configure

Change the severity (or turn the rule off) in .github/flowpact/flowpact.config.yml, by code or by name:

.github/flowpact/flowpact.config.yml
rules:
  FP810: off
  # or: impact-under-declared: error

Explain it in the terminal:

flowpact explain FP810

On this page