Troubleshooting

The change-request check fails (GitHub, GitLab)

The CorPole check wants every pull request (GitHub) or merge request (GitLab) to cite at least one existing, non-retired record code.

For: Team developer, Project lead

Why it fails

  • The pull request cites no code at all.
  • It cites a code that does not exist.
  • It cites a Retired record. A retired decision cannot come back through a merge.
  • It warns, without failing, when a cited record is only Draft or Approved.
  • The file check fails or warns on changed files: code no record governs, modules still under onboarding review, overlap with other open work, or a change made under an emergency.

Fix it

  • Put the record code in the title or description, e.g. FR-7C21A4. A story code such as ST-1A2B3C links the work to the change as well, but the check itself needs the code of a record the change implements.
  • For a change that no requirement governs (a typo, formatting, a rename, a dependency patch) add the label no-requirement. It must not change behaviour.
  • If the check cannot reach CorPole at all, the token is missing or revoked: the repository secret CORPOLE_TOKEN on GitHub, the masked CI/CD variable CORPOLE_TOKEN on GitLab. A person with the integrations permission creates a service token for it.
  • On GitLab, check that .gitlab-ci.yml includes .gitlab/corpole.yml and that the pipeline runs for merge requests.

Feedback for CorPole