Skip to content

Run the complete policy suite from the README and CI #259

Open

Description

@taras

Parent Quest: #254

Story

As an effectionx contributor, I want to run the complete policy suite from the README before opening a pull request, so I see the same policy verdicts and evidence that CI will evaluate.

The README is the executable entrypoint:

xmd run README.md#Policies

Current gap

Policies are discoverable through .policies/index.md, but the README does not compose them into a runnable workflow. Local review and CI therefore have no shared entrypoint, and a new policy could be documented without becoming part of the enforced suite.

Contract

Add a Policies XMD entrypoint to the README that discovers every active policy from the authoritative policy index and executes each policy’s public Validate entrypoint.

The workflow:

  • uses the same command, policy inventory, validator declarations, tool versions, and repository inputs locally and in CI;
  • runs lint-backed policies through their declared @effectionx/lint rules;
  • runs AI-backed policies through their declared review procedures;
  • reports each policy, validation method, verdict, and supporting evidence;
  • exits unsuccessfully when any active policy fails or cannot run;
  • never silently skips a policy because a validator, credential, input, or entrypoint is unavailable; and
  • does not maintain a second hard-coded policy list in the README or CI configuration.

The README explains prerequisites and shows both the complete-suite command and the individual-policy command used for focused investigation.

Acceptance

  • A contributor can start from a clean checkout, follow the README, and run the complete active policy suite.
  • CI invokes the same README #Policies entrypoint.
  • The aggregate result identifies every active policy and how it was validated.
  • Adding an active policy without a runnable Validate entrypoint makes the aggregate workflow fail.
  • A deliberate lint-backed violation produces a non-zero result naming the policy and rule.
  • A deliberate AI-backed violation produces a non-zero result naming the policy and required evidence.
  • An unavailable validator prerequisite fails with an actionable diagnostic rather than being reported as a pass.
  • The historical corpus from Test policy validation against historical pull requests #258 passes before the aggregate workflow is accepted.
  • Existing contributor commands for build, typecheck, lint, format, and tests remain documented and available.

Evidence

Verification records the output of the README entrypoint locally and in CI, including one lint-backed failure, one AI-backed failure, one unavailable-validator failure, and a clean full-suite pass.

Dependencies

Out of scope

  • Policies outside the effectionx repository
  • Deno lint compatibility
  • A separate CI-only policy implementation
  • Silently downgrading failed or unavailable validators
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

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions