Skip to content

Regenerate against the SPDX headers: every citation moves by two - #19

Closed
arpanghoshal wants to merge 2 commits into
mainfrom
quality/spdx-headers
Closed

arpanghoshal wants to merge 2 commits into
mainfrom
quality/spdx-headers

Conversation

@arpanghoshal

Copy link
Copy Markdown
Member

What this changes

Pairs with CTRLRun/ctrlrun#181, which puts two comment lines at the top of every source file, so every line number under src/ moves by two.

  • docs/CLAIMS.md: scripts/repoint-claims.py re-derived 151 citations from the definitions they name, against the kernel branch quality/spdx-headers. The three it refuses to guess at (a float check in action.py and a DDL line in migrations.py, which are not definitions) were moved by hand and checked against the same tree.
  • docs/reference/api/*.mdx: render_api.py --write regenerated the 83 pages against the same tree; --check reports 0 drifted.

The table was already stale against main from today's v0.10 merges (97 rows), which is why the repointer also moved rows the headers did not touch; that drift would have surfaced on the next library-changed dispatch.

This branch carries the kernel branch's name, so CI here checks these pages against that kernel branch, and the kernel's docs job on #181 checks that branch against these pages. Merge order: #181 there first, then this; between the two, main here is red on the claims test for a few minutes.

tests/test_claims_and_adapters.py and tests/test_claims_citations.py pass against the kernel branch.

🤖 Generated with Claude Code

CTRLRun/ctrlrun#181 puts two comment lines at the top of every source file,
so every line number under src/ moves by two. scripts/repoint-claims.py
re-derived 151 citations in CLAIMS.md from the definitions they name against
that tree; the three it cannot resolve (a float check and two DDL lines, not
definitions) were moved by hand and checked. render_api.py --write regenerated
the 83 API reference pages against the same tree.

The table was already stale against main from today's v0.10 merges, which is
why the repointer moved rows this pull request's headers did not touch. The
branch carries the kernel branch's name, so CI here checks these pages against
that branch and the kernel's docs job checks that branch against these pages.

Signed-off-by: arpan <contact@arpanghoshal.com>
@mintlify

mintlify Bot commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
ctrlrun 🟢 Ready View Preview Sep 13, 2026, 10:37 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Sep 13, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 31 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 740b594d-bc9c-447f-9d06-09d90c31fc43

📥 Commits

Reviewing files that changed from the base of the PR and between 351ef20 and 5f01f0f.

📒 Files selected for processing (83)
  • docs/CLAIMS.md
  • docs/reference/api/Action.mdx
  • docs/reference/api/ActionDenied.mdx
  • docs/reference/api/AmbiguousEffect.mdx
  • docs/reference/api/Approval.mdx
  • docs/reference/api/ApprovalAnswer.mdx
  • docs/reference/api/ApprovalMismatch.mdx
  • docs/reference/api/ApprovalProvider.mdx
  • docs/reference/api/ApprovalRequest.mdx
  • docs/reference/api/ApprovalRequired.mdx
  • docs/reference/api/ApprovalTimeout.mdx
  • docs/reference/api/ApproverIdentity.mdx
  • docs/reference/api/Authority.mdx
  • docs/reference/api/AuthorityDenied.mdx
  • docs/reference/api/AuthorityEscalation.mdx
  • docs/reference/api/AuthorityResult.mdx
  • docs/reference/api/CTRLRunError.mdx
  • docs/reference/api/Condition.mdx
  • docs/reference/api/Control.mdx
  • docs/reference/api/Decision.mdx
  • docs/reference/api/Delegation.mdx
  • docs/reference/api/DelegationRecord.mdx
  • docs/reference/api/DuplicateEffect.mdx
  • docs/reference/api/EffectKeyError.mdx
  • docs/reference/api/EffectRecord.mdx
  • docs/reference/api/EffectState.mdx
  • docs/reference/api/Event.mdx
  • docs/reference/api/EventSink.mdx
  • docs/reference/api/FrameworkInterrupt.mdx
  • docs/reference/api/Grant.mdx
  • docs/reference/api/HeaderIdentityProvider.mdx
  • docs/reference/api/IdentityContext.mdx
  • docs/reference/api/IdentityError.mdx
  • docs/reference/api/IdentityProvider.mdx
  • docs/reference/api/InMemoryStateStore.mdx
  • docs/reference/api/InterruptApprovalProvider.mdx
  • docs/reference/api/InvalidArgument.mdx
  • docs/reference/api/JSONLEventSink.mdx
  • docs/reference/api/LocalApprovalProvider.mdx
  • docs/reference/api/MissingDependency.mdx
  • docs/reference/api/NotExecuted.mdx
  • docs/reference/api/PendingApproval.mdx
  • docs/reference/api/Policy.mdx
  • docs/reference/api/PolicyError.mdx
  • docs/reference/api/Principal.mdx
  • docs/reference/api/Receipt.mdx
  • docs/reference/api/ReconcileOutcome.mdx
  • docs/reference/api/SQLiteStateStore.mdx
  • docs/reference/api/SchemaMismatch.mdx
  • docs/reference/api/ScriptedApprovalProvider.mdx
  • docs/reference/api/StateStore.mdx
  • docs/reference/api/StaticIdentityProvider.mdx
  • docs/reference/api/Subject.mdx
  • docs/reference/api/Suspended.mdx
  • docs/reference/api/VerifiedApprover.mdx
  • docs/reference/api/WebhookApprovalProvider.mdx
  • docs/reference/api/acs-AcsControlHook.mdx
  • docs/reference/api/action_hash.mdx
  • docs/reference/api/authority-Budget.mdx
  • docs/reference/api/banner.mdx
  • docs/reference/api/canonical_bytes.mdx
  • docs/reference/api/canonicalize.mdx
  • docs/reference/api/conformance-run.mdx
  • docs/reference/api/conformance-store-run.mdx
  • docs/reference/api/context.mdx
  • docs/reference/api/gateway-serve.mdx
  • docs/reference/api/idempotency_token.mdx
  • docs/reference/api/jwt_identity-JWTIdentityProvider.mdx
  • docs/reference/api/needs_approval.mdx
  • docs/reference/api/otel-OTelEventSink.mdx
  • docs/reference/api/parse_conditions.mdx
  • docs/reference/api/postgres-PostgresStateStore.mdx
  • docs/reference/api/protect.mdx
  • docs/reference/api/state-Charge.mdx
  • docs/reference/api/state-Consumption.mdx
  • docs/reference/api/state-check_charges.mdx
  • docs/reference/api/transport-HTTPConnection.mdx
  • docs/reference/api/transport-HTTPSConnection.mdx
  • docs/reference/api/transport-Transport.mdx
  • docs/reference/api/transport-effect_state.mdx
  • docs/reference/api/transport-urlopen.mdx
  • docs/reference/api/verify-run.mdx
  • docs/reference/api/with_approval.mdx

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@arpanghoshal

Copy link
Copy Markdown
Member Author

Correction to the description: the branch-name pairing lives in the unmerged branch ci/docs-job-follows-the-branch here, not on main, so this run checked against the kernel's main (no headers yet) and every repointed row reads two lines early. That is the expected red until CTRLRun/ctrlrun#181 merges; a rerun of check after that is green. Locally, against the kernel branch quality/spdx-headers, tests/test_claims_and_adapters.py and tests/test_claims_citations.py pass and render_api.py --check reports 0 drifted.

Kernel main moved under src/ after the tree #181 was cut from, so 31 rows
drifted between the first repoint and the merge. Re-derived against main as
it is now; the API reference regenerated against the same tree.

Signed-off-by: arpan <contact@arpanghoshal.com>
@arpanghoshal

Copy link
Copy Markdown
Member Author

Superseded by #22, which regenerated CLAIMS.md and the API reference against the kernel's release/0.10.0 (now main), a newer tree than this branch's, and is merged. Nothing here is lost.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant