Skip to content

The docs job installs the postgres extra, so it counts the suite check runs - #150

Merged
rohanrkamath merged 2 commits into
mainfrom
ci/docs-job-installs-postgres
Sep 13, 2026
Merged

rohanrkamath merged 2 commits into
mainfrom
ci/docs-job-installs-postgres

Conversation

@arpanghoshal

Copy link
Copy Markdown
Member

What this changes

CI only. The docs job's editable install gains the postgres extra, matching check, and a repository-signals test holds the two install lines equal.

Why. The readiness audit (render_readiness.py --check in ctrlrun-docs) fails when the checkout collects fewer tests than the block records. It has failed on main since the 0.7.0 block was written: "claims 5,167, collects 5,091". The 76-test gap is exactly the Postgres tests, which are collected only when psycopg is importable. Reproduced on one tree: .[dev,gateway,otel,identity] collects 3,461, adding postgres collects 3,537. The block was right; the job was counting a smaller suite than check runs.

Checklist

  • Specification first. Not applicable: CI only.
  • Tests first. test_the_docs_job_installs_the_extras_the_check_job_runs is red on main and green here.
  • Mutation table. Below.
  • CLAIMS.md. No README sentence changed.
  • Docs audit green. This is what makes it green; the docs job on this PR is the evidence.
  • scripts/check.sh green for the touched file.
  • Independent review. Not applicable.
  • Nothing in src/.
  • Signed off.

Mutation table

Guard Test Result
postgres removed from the docs job's install line test_the_docs_job_installs_the_extras_the_check_job_runs red

🤖 Generated with Claude Code

…k runs

The readiness block in ctrlrun-docs records what `pytest --collect-only`
finds across both checkouts, and the audit fails when a checkout collects
fewer tests than the block claims. The docs job installed every extra but
`postgres`, and 76 tests exist only when psycopg is importable: 3,461
collected without it against 3,537 with, on the same tree. So the audit
has been comparing a block generated with the full suite against a job
that could never see all of it, and reporting the block as stale when it
was right.

The job now installs the same extras as `check`, and a repository-signals
test reads both install lines and holds them equal.

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

coderabbitai Bot commented Sep 12, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 29 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: 7374050a-1266-4979-a41d-55386b6eec95

📥 Commits

Reviewing files that changed from the base of the PR and between feeb4b9 and 7c5775e.

📒 Files selected for processing (4)
  • .github/workflows/ci.yml
  • requirements/docs.txt
  • scripts/lock.sh
  • tests/test_repository_signals.py

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.

…h-pinned

main moved both jobs onto requirements/*.txt by hash, so the extras this PR added to the docs
job's pip line no longer live in the workflow. They live in scripts/lock.sh, and docs.txt now
takes --extra postgres exactly as ci.txt does.

The test moves with them: it compared two pip install -e .[...] strings in ci.yml and would now
read nothing, so it compares the two locks instead and requires docs.txt to cover ci.txt.

Signed-off-by: arpan <arpanghoshalwork@gmail.com>
@rohanrkamath

Copy link
Copy Markdown
Contributor

lgtm

@rohanrkamath
rohanrkamath merged commit 80acaca into main Sep 13, 2026
17 checks passed
@rohanrkamath
rohanrkamath deleted the ci/docs-job-installs-postgres branch September 13, 2026 10:55
arpanghoshal added a commit to CTRLRun/ctrlrun-docs that referenced this pull request Sep 13, 2026
CTRLRun/ctrlrun#150 put the postgres extra in the docs lock so that job collects the suite the
check job runs. It collects five more tests than the block recorded, which the audit does not
fail on, because it only fails when the block claims MORE than the suite collects. Understating
is still not the number.

Signed-off-by: arpan <contact@arpanghoshal.com>
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.

2 participants