Skip to content

docs(claude): reframe internal/<pin>-stable as opt-in bump sandbox - #45

Merged
songkuan-zheng merged 1 commit into
ship/v1.83.10from
fix/claude-md-internal-sync-clarify
Jun 4, 2026
Merged

docs(claude): reframe internal/<pin>-stable as opt-in bump sandbox#45
songkuan-zheng merged 1 commit into
ship/v1.83.10from
fix/claude-md-internal-sync-clarify

Conversation

@songkuan-zheng

Copy link
Copy Markdown
Collaborator

Tier classification

  • A — Company-specific logic (litellm_extras/ only)
  • B — Internal infra / branding (CI, Dockerfile, e2e, internal navbar version)
  • C — Universal bug fix in litellm/ core
  • D — Universal mechanism + company opinion in litellm/ core

If Tier C or D, did you try upstream first?

  • N/A — Tier B docs change.

Relevant issues

None — follow-up to #43 and #44.

Summary

The original description of internal/<pin>-stable as "Upstream-sync
working branch | collects upstream commits" implied a continuous mirror
the branch must serve. In practice we never used it that way — the
existing internal/v1.83.10-stable just passively accumulated 1700+
upstream commits we never consumed.

Now that scripts/upstream-sync-check.sh (#44) covers routine sync
visibility, the only remaining value of internal/<pin>-stable is as a
sandbox to test-merge upstream/main before a version bump (catches
conflicts without polluting the ship branch).

What changes

Two focused edits in CLAUDE.md § Branching strategy:

  • Table row for internal/<pin>-stable: marked Optional, describes
    the actual bump-preview use case, drops the "Upstream-sync working
    branch" framing.
  • Paragraph under the table: points at scripts/upstream-sync-check.sh
    for routine awareness; explicitly notes the sandbox is opt-in, not a
    continuous mirror.

Diff is 5 lines net.

How to verify

Open CLAUDE.md → Branching strategy. The internal/<pin>-stable row
should read "Optional bump-preview sandbox..." and the paragraph below
should reference scripts/upstream-sync-check.sh.

Pre-Submission checklist

  • Docs-only change.
  • No code touched, no tests affected.
  • No other CLAUDE.md sections rewritten — minimal-surface edit.

Type

📖 Documentation

The historical description ("Upstream-sync working branch | collects
upstream commits") implied a continuous mirror that internal/* must
serve. In practice we never used it that way — internal/v1.83.10-stable
just passively accumulated 1700+ upstream commits we never consumed.

Now that scripts/upstream-sync-check.sh (added in #44) covers routine
sync visibility, internal/<pin>-stable's remaining value is as a
sandbox to test-merge upstream/main before a version bump (catches
conflicts without polluting the ship branch).

Updates:
- Branching strategy table row: mark branch as Optional, describe the
  actual bump-preview use case, drop "Upstream-sync working branch"
  framing.
- Paragraph under the table: point at scripts/upstream-sync-check.sh
  for routine awareness; explicitly note the internal/<pin>-stable
  sandbox is opt-in, not a continuous mirror.

No code or other docs touched.

Tier: B (internal infra / policy doc, not pushed upstream).
@songkuan-zheng
songkuan-zheng merged commit 8322697 into ship/v1.83.10 Jun 4, 2026
@songkuan-zheng
songkuan-zheng deleted the fix/claude-md-internal-sync-clarify branch June 4, 2026 09:49
songkuan-zheng added a commit that referenced this pull request Jun 4, 2026
…ning (#55)

Ports the current state of ` CLAUDE.md`, ` scripts/upstream-sync-check.sh`,
and ` .github/pull_request_template.md` from ship/v1.83.10 to
ship/v1.87.0, and flips the Current pinning block to point at v1.87.0.

Before this PR the policy doc was orphaned: Wave 2 (#47) cherry-picked
an OLD version of CLAUDE.md from f67766f (when our policy doc was a
50-line skeleton). PRs #43, #45 added the Tier classification, Current
pinning, and Upstream sync cadence sections on ship/v1.83.10, but they
never crossed over to ship/v1.87.0. PR #44 added
` scripts/upstream-sync-check.sh` on ship/v1.83.10 only.

After this PR, ship/v1.87.0 has the full policy state, and the
sync script auto-discovers ` v1.87.0` from CLAUDE.md (verified locally
— reports 100 commits on upstream/main since the new pin, 0 missed
backports, 0 newer minor lines).

## Changes

- ` CLAUDE.md`
  - Current pinning block flipped to v1.87.0 (Upstream pin, Ship
    branch, Upstream-sync branch, Internal release tag pattern).
  - Branching strategy table examples updated to ` v1.87.0` /
    ` ship/v1.87.0` / ` internal/v1.87.0-stable`. The pin tag column
    notes the historical ` vX.Y.Z-stable` form (used pre-1.84.0) so
    older grep results still resolve.
  - Cutting an internal release example updated to
    ` v1.87.0-internal.1` (N restarts at 1 under the new pin per the
    release-tag.sh contract).
  - Upstream sync cadence example covers both the new ` vX.Y.W` and
    the legacy ` .patch.N` patch-tag conventions.
  - ` git tag -l 'v1.87.0-internal.*'` for the latest-release lookup.
- ` scripts/upstream-sync-check.sh` — copied verbatim from
  ship/v1.83.10. Re-reads the new pin without any code change.
- ` .github/pull_request_template.md` — copied verbatim from
  ship/v1.83.10 (Tier classification checkbox section).

Tier: B (internal policy / branding doc; not pushed upstream).
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