Skip to content

docs: document release pathway + guard unpublished channels in AGENTS.md#1108

Merged
aallan merged 1 commit into
mainfrom
docs/agents-release-install-guardrails
Jul 17, 2026
Merged

docs: document release pathway + guard unpublished channels in AGENTS.md#1108
aallan merged 1 commit into
mainfrom
docs/agents-release-install-guardrails

Conversation

@aallan

@aallan aallan commented Jul 17, 2026

Copy link
Copy Markdown
Owner

What

Adds a Releases and install docs section to AGENTS.md and an unpublished-channel guard to CLAUDE.md's release-workflow section.

Why

An agent twice documented a distribution channel as an available install route before the artifact was live there — first pip install veralang before it was on PyPI, then the VS Code Marketplace install route before the extension was accepted (backed out in #1107). The root cause is structural: AGENTS.md had no release-pathway or install-docs guidance at all, so the correction never stuck.

Changes

  • AGENTS.md — new Releases and install docs section:
    • Releases are automated after merge (release.yml → approval-gated pypi environment → Trusted Publishing → tag + GitHub Release at the merge SHA); don't create tags, run twine, or gh release create.
    • Install docs are circumstance-dependent — match README.md / SKILL.md / PYPI_README.md (source checkout = full environment and the recommended route for agents; pip install veralang = toolchain only; never pip install vera), and never document a channel as available before it's live (the VS Code extension is still blocked — VS Code Marketplace rejects extension as suspicious content #1106).
  • CLAUDE.md — the same unpublished-channel guard added to ## Release workflow (its mechanics were already correct).
  • docs/llms-full.txt — regenerated by scripts/build_site.py.

Docs-only; no version bump. check_doc_counts, check_site_assets, and check_changelog_updated all pass locally.

🤖 Generated with Claude Code

AGENTS.md gains a Releases-and-install-docs section (its only persistent context lacked one): releases are automated after merge (no manual tag/twine/gh release), and install docs must match README/SKILL/PYPI_README (source checkout = full env + agent default; `pip install veralang` = toolchain only; never `pip install vera`). Both AGENTS.md and CLAUDE.md now forbid documenting a distribution channel as available before it's live — the VS Code Marketplace extension is still blocked (#1106). Regenerates docs/llms-full.txt.

Co-Authored-By: Claude <noreply@anthropic.invalid>
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 13 minutes

Your organization has reached its usage spending cap. Adjust your spending cap in the billing tab.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: c21e3fdd-22ab-40e9-a176-5689004dbc16

📥 Commits

Reviewing files that changed from the base of the PR and between 7e9d04f and f552689.

⛔ Files ignored due to path filters (1)
  • docs/llms-full.txt is excluded by !docs/**
📒 Files selected for processing (2)
  • AGENTS.md
  • CLAUDE.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/agents-release-install-guardrails

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

@codecov

codecov Bot commented Jul 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.72%. Comparing base (7e9d04f) to head (f552689).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1108   +/-   ##
=======================================
  Coverage   93.72%   93.72%           
=======================================
  Files          96       96           
  Lines       32708    32708           
  Branches      456      456           
=======================================
  Hits        30654    30654           
  Misses       2041     2041           
  Partials       13       13           
Flag Coverage Δ
javascript 78.41% <ø> (ø)
python 95.48% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@aallan

aallan commented Jul 17, 2026

Copy link
Copy Markdown
Owner Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.


You're currently rate limited under our Fair Usage Limits Policy. Your recent PR review activity is in the 95th percentile or higher among CodeRabbit users, so adaptive limits apply. Your next review will be available in 13 minutes.

@aallan
aallan merged commit 6aa9396 into main Jul 17, 2026
28 checks passed
@aallan
aallan deleted the docs/agents-release-install-guardrails branch July 17, 2026 19:25
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