Skip to content

fix: base release-notes assembly branch on main to exclude unrelated diffs#1827

Merged
ahg-g merged 4 commits into
llm-d:mainfrom
liu-cong:fix-release-notes-assemble-base
Jun 27, 2026
Merged

fix: base release-notes assembly branch on main to exclude unrelated diffs#1827
ahg-g merged 4 commits into
llm-d:mainfrom
liu-cong:fix-release-notes-assemble-base

Conversation

@liu-cong

@liu-cong liu-cong commented Jun 26, 2026

Copy link
Copy Markdown
Member

Summary

  • Fixes the release-notes assembly workflow including unrelated files in the auto-generated PR (e.g. hack/push-chart.sh in docs: assemble release notes for v0.9.0 #1688).
  • Root cause: the tag lives on a release branch that carries release-specific changes (e.g. pinned image versions) that must never be merged back to main. The workflow branched from the tagged commit, so those release-branch-only changes leaked into the PR diff against main.
  • Fix: split the script into three phases:
    1. Read fragments from the tagged commit — preserves the existing guard against post-tag fragments.
    2. Branch from origin/main — the PR now only contains release-notes file changes, not release-branch-specific diffs.
    3. Apply changes on main — update RELEASE-NOTES.md and remove only the fragments that exist on main.
  • Additionally, skip the assembly job entirely for RC tags (e.g. v0.9.0-rc.1) since release notes should only be assembled for final releases.

Test plan

Simulated the fixed workflow locally against the v0.9.0 tag (which lives on a release branch that diverges from main):

  • Fragments are read from the tagged commit: found 40 fragments on v0.9.0.
  • Branch is created from origin/main, not the tagged commit.
  • Only RELEASE-NOTES.md is staged — no unrelated files (e.g. hack/push-chart.sh) appear in the diff.
  • Fragments already removed from main (by the original docs: assemble release notes for v0.9.0 #1688 merge) are safely skipped via the -f guard.
  • No fragments merged after the tag are picked up (glob runs on the tagged commit checkout, not main).
  • RC tags are excluded via if: ${{ !contains(github.ref_name, '-rc') }} condition on the job.

…diffs

The workflow previously created its branch from the tagged commit.
When the tag diverged from main HEAD, the PR diff included unrelated
changes (e.g. hack/push-chart.sh in llm-d#1688).

Split the script into three phases:
1. Read fragments from the tagged commit (preserves the guard against
   post-tag fragments).
2. Fetch and branch from origin/main so the PR only diffs release-notes
   files against main.
3. Apply changes and remove only the fragments that exist on main.

Signed-off-by: Cong Liu <conliu@google.com>
@github-actions github-actions Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 26, 2026
Signed-off-by: Cong Liu <conliu@google.com>
@liu-cong
liu-cong marked this pull request as ready for review June 26, 2026 19:22
@liu-cong
liu-cong requested a review from a team as a code owner June 26, 2026 19:22
@liu-cong
liu-cong requested review from Copilot, elevran and vMaroon June 26, 2026 19:22

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@liu-cong

Copy link
Copy Markdown
Member Author

cc @elevran @ahg-g @vMaroon

liu-cong added 2 commits June 26, 2026 12:26
Signed-off-by: Cong Liu <conliu@google.com>
Signed-off-by: Cong Liu <conliu@google.com>
@ahg-g
ahg-g merged commit c19cadc into llm-d:main Jun 27, 2026
20 checks passed
abdallahsamabd pushed a commit to abdallahsamabd/llm-d-inference-scheduler that referenced this pull request Jul 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants