Skip to content

docs: make the "Aligning @next" section consistent with the deprecation - #404

Merged
jobordu merged 2 commits into
mainfrom
nf/quick-404-align-section-consistency
Aug 9, 2026
Merged

docs: make the "Aligning @next" section consistent with the deprecation#404
jobordu merged 2 commits into
mainfrom
nf/quick-404-align-section-consistency

Conversation

@jobordu

@jobordu jobordu commented Aug 9, 2026

Copy link
Copy Markdown

#403 deprecated @next, but left the older section below it describing the world before that decision:

The pattern worth naming

This file has shipped an internal contradiction twice in two days, and a reviewer caught it both times. The cause is consistent: I keep adding a correct new section without reconciling what it supersedes. Worth stating in the commit so the next edit checks the whole file rather than the paragraph being changed.

Now

  • Manual alignment is marked optional, explicitly not gating a release.
  • The expired secret is documented as not worth fixing, rather than sitting there as an implied pending chore.
  • The "make it automatic" recipe is kept but marked deliberately not recommended, with the reasoning attached: 2FA-bypass tokens lose direct publishing on a targeted January 2027, they expire silently before then, and it would reintroduce a long-lived publish-capable credential into an otherwise all-OIDC pipeline. The tag being aligned is deprecated; the credential would be real.
  • Verification reads latest is authoritative, next may lag, and that's expected.

Docs only.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified that automated @next channel alignment may remain inactive when the publishing token expires.
    • Documented that manual alignment is optional and that latest remains the authoritative release channel.
    • Added guidance that next may legitimately differ from latest.
    • Warned against restoring automation with a long-lived publishing token.

#403 deprecated @next but left the older section below it still describing the old
world: "alignment is a manual step after every release", "always verify ... must
show next == latest", and a straightforward recipe for putting a token back. All
three now contradict the policy two sections up.

This file has already shipped an internal contradiction twice in two days and both
times a reviewer caught it, so the pattern is worth naming: I keep ADDING a
correct new section without reconciling what it supersedes.

Now: alignment is explicitly optional and never gates a release; the expired
secret is documented as not worth fixing rather than as a pending chore; the
"make it automatic" recipe is retained but marked deliberately NOT recommended,
with the reason (2FA-bypass tokens lose publishing ~Jan 2027, they expire
silently, and it reintroduces a long-lived publish credential to an otherwise
all-OIDC pipeline — the tag is deprecated, the credential would be real); and
verification says `latest` is authoritative with `next` permitted to lag.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 9, 2026 15:00
@coderabbitai

coderabbitai Bot commented Aug 9, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@jobordu, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 49 minutes

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

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: CHILL

Plan: Pro Plus

Run ID: 76b608bd-5078-485c-a7b8-24b4e85d3c6f

📥 Commits

Reviewing files that changed from the base of the PR and between 725534f and 7d162b1.

📒 Files selected for processing (1)
  • CLAUDE.md

Walkthrough

The publishing documentation makes @next alignment optional, documents the expired NPM_TOKEN, discourages long-lived token automation, and identifies latest as authoritative.

Changes

Publishing guidance

Layer / File(s) Summary
Dist-tag publishing guidance
CLAUDE.md
The documentation treats @next alignment as optional, provides manual alignment instructions, discourages token-based automation, and states that latest is authoritative while next may drift.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested reviewers: glittercowboy

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change and rationale but omits the required template sections for testing, checklist, and breaking changes. Use the repository template and complete the Testing, Checklist, and Breaking Changes sections with applicable details.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the documentation update and its alignment with the deprecated @next policy.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch nf/quick-404-align-section-consistency

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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the release documentation in CLAUDE.md to remove internal contradictions around the now-deprecated @next dist-tag, aligning the “Aligning @next” section with the current policy that @latest is authoritative and @next may drift.

Changes:

  • Reframes NPM_TOKEN expiration as intentionally not worth fixing because @next alignment is optional post-deprecation.
  • Clarifies manual @next alignment as optional and explicitly non-gating for releases.
  • Rewords the “make it automatic again” guidance to keep the steps but mark them as deliberately not recommended, and updates the “Checking” guidance to treat drift as expected.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CLAUDE.md`:
- Around line 154-165: The earlier publishing summary must no longer claim that
CI automatically aligns `@next` or enforce an alias invariant. Update that summary
to state that `@latest` publication is required, while `@next` alignment is best
effort, optional, and non-blocking, consistent with the guidance in the manual
alignment and checking sections.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: bdd841a3-0cb3-422f-8649-932e698838c6

📥 Commits

Reviewing files that changed from the base of the PR and between 399450f and 725534f.

📒 Files selected for processing (1)
  • CLAUDE.md

Comment thread CLAUDE.md
…ed line

Third instance of the pattern I named in the previous commit, caught by review
again — which makes the lesson the point rather than the line.

Line 141 still described CI as aligning @next "per the alias invariant". Rather
than patch it and wait to be told about the next one, I grepped every mention of
alias / invariant / @next in the file:

  - publish flow: now says the step ATTEMPTS alignment of a deprecated alias, is
    inert while NPM_TOKEN is expired, and is not required for a correct release.
  - the prerelease rule (twice, lines 10 and 106) justified itself by "the alias
    policy". The rule still holds — a prerelease on @latest installs for everyone
    — but the justification now stands on "there is only one channel" instead of
    an invariant that no longer exists.

Fixing one flagged line at a time is what produced three rounds of this. The
check that actually works is: after changing a policy, grep the file for every
term that policy touches.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings August 9, 2026 15:11

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@jobordu
jobordu merged commit fedb6cd into main Aug 9, 2026
17 checks passed
@jobordu
jobordu deleted the nf/quick-404-align-section-consistency branch August 9, 2026 15:21
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