Skip to content

ci: add a dryRun input to the Prepare release dispatch - #2255

Merged
chhoumann merged 1 commit into
masterfrom
ci/release-dry-run-input
Oct 24, 2026
Merged

chhoumann merged 1 commit into
masterfrom
ci/release-dry-run-input

Conversation

@chhoumann

@chhoumann chhoumann commented Oct 24, 2026 •

Copy link
Copy Markdown
Owner

Adds a dryRun checkbox, defaulting to false, to the Prepare release workflow_dispatch form, mirroring chhoumann/PodNotes#519. It forwards to the shared workflow's dry-run input, which skips the open-pr job. A manual run then plans the version and notes without opening, refreshing or closing a release PR. Before this, a dry run meant uncommenting a line in the stub.

The automatic workflow_run path has no inputs, so it passes false and behaves as before. The shared workflow stays pinned to 149e37801b35c120660a1fd5e78a5471fda55726 # v4.1.0.

Verification

Prepare release dispatched from this branch with dryRun: true. The run link is in a comment below.

Release impact

None. The standing release PR is untouched and no release is cut.


Note

Low Risk
CI workflow dispatch wiring only; release behavior on the automatic path is unchanged.

Overview
Adds a dryRun checkbox (default off) to the manual Prepare release workflow_dispatch, wired to the reusable workflow’s dry-run input so a dispatched run can compute version and release notes without opening or refreshing the standing release PR.

Replaces the previous escape hatch of uncommenting a hard-coded dry-run: true in the stub. Automatic runs triggered after CI still pass dry-run: false because workflow_run has no inputs.

Reviewed by Cursor Bugbot for commit 3949472. Bugbot is set up for automated code reviews on this repo. Configure here.

Note

Add dryRun input to the Prepare release dispatch workflow

Adds an optional boolean dryRun input (default false) to the manual dispatch in release-prepare.yml. The input is passed through to the reusable release-preparation workflow, and the workflow documentation now describes dry-run planning.

Macroscope summarized 3949472.

Summary by CodeRabbit

  • New Features
    • Added an optional dry-run setting for manually dispatched release preparation. When enabled, it plans the release without opening or refreshing a release pull request.
  • Documentation
    • Updated the manual-dispatch guidance to explain how to plan a release without changing the release pull request.

@coderabbitai

coderabbitai Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 5fb33c6b-0274-4610-a132-2349860e1f83
Commits

Reviewing files that changed from the base of the PR and between 6802ac8 and 3949472.

Files selected for processing: 1
  • .github/workflows/release-prepare.yml

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 6 remain after this review.

Walkthrough

The manual release workflow now accepts a dryRun boolean, defaulting to false. It passes dry-run: true to the reusable workflow when dryRun is true. The dispatch documentation describes planning without opening or refreshing the release PR.

Changes: Release preparation dry-run

Layer / File(s) Summary
Configure the dry-run input
.github/workflows/release-prepare.yml
The workflow adds a default-false dryRun input and passes its value to the reusable workflow. The dispatch documentation describes dry-run planning and removes the prior commented example.

Priority: Low

Estimated code review effort: 2 (Simple) | ~5 minutes

Change: Feature

Possibly related PRs

Merge Risk: Minimal · up to 39494

The dry-run option is correctly wired and does not introduce a merge-blocking risk.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: adding a dryRun input to the Prepare release dispatch workflow.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

A rabbit checks the release plan,
With dry-run tucked inside the span.
No PR opens, none gets refreshed,
The workflow takes the input tested.
Then hops away, its checklist blessed.

Comment @coderabbitai help to get the list of available commands.

@chhoumann

Copy link
Copy Markdown
Owner Author

Dry run from this branch with dryRun: true: https://github.com/chhoumann/quickadd/actions/runs/40097932353

Plan release succeeded and planned 2.33.0. Open release PR was skipped. Afterwards release PR #2240 kept head 5fbd0ba and its updated time, the latest release is still 2.32.1, and the tag count did not change.

@chhoumann
chhoumann merged commit f9f6a2d into master Oct 24, 2026
16 of 19 checks passed
@chhoumann
chhoumann deleted the ci/release-dry-run-input branch October 24, 2026 14:07
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