Skip to content

chore[notask]: document changelog lockstep base and holepunch prettier - #4569

Open
opaninakuffo wants to merge 6 commits into
mainfrom
chore/qv-sdk-changelog-lockstep-prettier
Open

opaninakuffo wants to merge 6 commits into
mainfrom
chore/qv-sdk-changelog-lockstep-prettier

Conversation

@opaninakuffo

@opaninakuffo opaninakuffo commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

🎯 What problem does this PR solve?

Changelog generate is git log <base>..HEAD. That range is not the consumer delta, so notes can miss exports, routes, and catalog removals that are already in the tree vs the last published tag. A failed NOTICE npm install can also wipe the JS section.

📝 How does it solve it?

  • Lockstep sdk + inference share one display floor; when that floor is a patch, union the main-only window. SDK is the consumer set; inference is the engine slice.
  • After generate, every package audits public surface (exports, serve/HTTP routes, constants) against the last published <slug>-v* tag and hand-adds gaps. models.md is the full list; catalog-as-API removals go in breaking.md.
  • NOTICE: do not commit a wiped JS section if install failed. Restore JS from HEAD; keep successful model-scan adds.
  • Release changelog PR titles stay chore: (no [bc]); body API / Models / Breaking are copied from changelog/<this version>/.
  • Prettier loads holepunch, scoped to this package's version folder. Nested-worktree GIT_DIR and org-remote push stay in footguns.

🧪 How was it tested?

  • Procedure used on the current lockstep changelog cascade (generate floor + union, published-tag hand-adds, NOTICE restore-on-failed-install). This PR is skill-only.

@opaninakuffo
opaninakuffo requested review from a team as code owners September 17, 2026 22:24
@github-actions

Copy link
Copy Markdown
Contributor

Review Status

Current Status: ❌ PENDING
Approvals so far: none

Pending reviews: Needs 1 Management or Team Lead, and 1 more from Management, Team Lead, or Member.

@github-actions

Copy link
Copy Markdown
Contributor

License compliance — clean

No new dependency license findings in this PR.

Warn-only (shadow) mode — this check does not block merges yet.

Updated automatically by the canonical license compliance workflow.

NOTICE presence (advisory)

Missing NOTICE (advisory, does not block):

  • ./docs/website
  • ./packages/fabric/test/integration
  • ./packages/llm-llamacpp/benchmarks/server
  • ./packages/llm-llamacpp/benchmarks/performance
  • ./packages/inference-addon-cpp/mobile
  • ./packages/asr-ggml/benchmarks/server
  • ./packages/embed-llamacpp/benchmarks/server
  • ./packages/embed-llamacpp/benchmarks/performance
  • ./packages/sdk/e2e
  • ./packages/vla-ggml/sim/server
  • ./.github/actions/release-merge-guard

Victor-Rodzko
Victor-Rodzko previously approved these changes Sep 18, 2026
git log is the generate range, not the consumer delta. Catch missed
exports, routes, catalog removals, and NOTICE JS wipes on every package.
…edure

Lockstep always passes --base-commit; cascade follows the skill instead of
the generator shortcut; release heads stay chore/*-changelog.
Plugins are not under packages/<slug>. bun install is not safe while a
lockstep dep is unpublished.
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