Fix --fill-verbose parameter conflict in scheduled releases workflow #700
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The
--fill-verbose
flag in the scheduled releases workflow wasn't working as expected. Instead of populating the PR description with detailed commit information from changes betweenrel/weekly
andmain
, it was only showing the generic message we provided via the--body
parameter.Root Cause
After investigating the GitHub CLI documentation (
gh pr create --help
), we discovered that when both--body
and--fill-verbose
flags are provided together, the--body
parameter takes precedence and overwrites any autofilled content from--fill-verbose
.Solution
Removed the conflicting
--body
parameter from thegh pr create
command in the scheduled releases workflow.Additional Issue Discovered
When testing the fix with
gh pr create --fill-verbose --dry-run
, we discovered that the command fails with "could not find any commits between origin/rel/weekly and main" when the branches are synchronized (no new commits). This would cause the scheduled workflow to fail when there's nothing to release.Additional Solution
Added early exit logic following the same pattern used in
build.yml
- the workflow now checks if there are new commits betweenrel/weekly
andmain
before attempting to create a PR, preventing failures when branches are synchronized.End Result