Skip to content

signal_contract_audit --ci does not check that docs/signal_contracts.md matches render() #3341

Closed

Description

@squid-protocol

Problem

docs/signal_contracts.md says it is "Rendered from gitgalaxy/standards/signal_contracts.py … Do not edit by hand", but nothing checks that it's in sync. tests/signal_contract_audit.py --ci checks the registry against the module, not the rendered file against render().

It had drifted on main. Re-rendering for #3337 also added three entries other merged PRs had left out:

Fix

In --ci mode, fail when RENDER_PATH.read_text() != render(), with the message "run python tests/signal_contract_audit.py --render". The signal-contract CI job then catches the next drift in the PR that causes it.

Found during epic #3313, step 4 (#3337).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    ci-cdContinuous integration, delivery, and automated runnersdocumentationUpdates to standard operating procedures, guides, or wiki

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions