Skip to content

ci: move the release toolkit to v5.0.0 and the App client ID - #2256

Merged
chhoumann merged 1 commit into
masterfrom
ci/v5-client-id
Oct 24, 2026
Merged

chhoumann merged 1 commit into
masterfrom
ci/v5-client-id

Conversation

@chhoumann

@chhoumann chhoumann commented Oct 24, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Pins every chhoumann/obsidian-plugin-workflows reusable workflow to v5.0.0 (d6b3b8c2cf460059238043b32a08dcaa3be4828f).
  • v5 replaces the prepare workflow's app-id input with client-id, because actions/create-github-app-token deprecates app-id. The prepare stub now passes client-id: ${{ vars.RELEASE_APP_CLIENT_ID }}. The RELEASE_APP_CLIENT_ID repository variable is set to the App's Client ID.
  • A dryRun dispatch of Prepare release now also mints a read-only App token and checks its slug. It still opens no release PR.

Test plan


Note

Medium Risk
Changes release automation and GitHub App authentication inputs; misconfigured RELEASE_APP_CLIENT_ID could break prepare/dry-run until fixed.

Overview
Upgrades all three release pipeline caller workflows (release-prepare, release-trigger, release) to obsidian-plugin-workflows v5.0.0 by pinning the reusable workflow refs to d6b3b8c2cf460059238043b32a08dcaa3be4828f.

Prepare release now passes client-id from vars.RELEASE_APP_CLIENT_ID instead of app-id from vars.RELEASE_APP_ID, matching v5 and actions/create-github-app-token’s move away from app-id. Comments note that dryRun dispatch also validates App credentials (token mint + slug check) without opening a release PR.

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

Note

Move release toolkit workflows to v5.0.0 and rename App ID input to client-id

  • Updates the reusable workflow references for release-prepare, release-validate, and release from v4.1.0 to v5.0.0 in release-prepare.yml, release-trigger.yml, and release.yml.
  • Replaces the app-id input with client-id in the release-prepare job, now sourced from the RELEASE_APP_CLIENT_ID secret instead of RELEASE_APP_ID.
  • Behavioral Change: the release-prepare dry-run comment now states that the mode also checks App credentials without opening or refreshing the release PR. Reviewers should confirm the RELEASE_APP_CLIENT_ID secret exists in the repo, since RELEASE_APP_ID is no longer used.

Macroscope summarized e9a92b2.

Summary by CodeRabbit

  • Chores
    • Updated the release preparation, validation, and publishing processes to use the latest workflow version.
    • Clarified that dry-run checks verify the app credentials.
    • Updated the credential setting used during release preparation.

Pin every obsidian-plugin-workflows reusable workflow to v5.0.0. v5 replaces
the prepare workflow's app-id input with client-id, so the prepare stub now
passes vars.RELEASE_APP_CLIENT_ID. A dryRun dispatch now also mints a
read-only App token to check the credentials.
@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: ebb1b6ba-7c50-40fa-a1a1-30810f63e222
Commits

Reviewing files that changed from the base of the PR and between f9f6a2d and e9a92b2.

Files selected for processing: 3
  • .github/workflows/release-prepare.yml
  • .github/workflows/release-trigger.yml
  • .github/workflows/release.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 release workflows now use reusable workflow version v5.0.0. The Prepare workflow passes RELEASE_APP_CLIENT_ID through the client-id input, and its dry-run comment notes that planning checks App credentials.

Changes: Release workflow updates

Layer / File(s) Summary
Update reusable workflow references
.github/workflows/release-prepare.yml, .github/workflows/release-trigger.yml, .github/workflows/release.yml
All three workflows now reference v5.0.0. The Prepare workflow passes vars.RELEASE_APP_CLIENT_ID through client-id and updates its dry-run comment to mention the App credential check.

Priority: Low

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

Change: Other

Possibly related PRs

  • chhoumann/quickadd#2254: Pins the same three reusable release workflows to v4.1.0, which this PR updates to v5.0.0.
  • chhoumann/quickadd#2255: Adds the dry-run input that this PR retains while updating the shared workflow version and dry-run comment.
  • chhoumann/quickadd#2253: Changes release automation setup related to reusable workflow dependency resolution; this PR updates the same workflows.
Merge Risk: Minimal · up to e9a92

No actionable merge-blocking risk is established by the reviewed changes.

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 "ci: move the release toolkit to v5.0.0 and the App client ID" matches the main change. The three workflow files pin the reusable workflows to v5.0.0 instead of v4.1.0. The prepare 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: Title check

Explanation

The title "ci: move the release toolkit to v5.0.0 and the App client ID" matches the main change. The three workflow files pin the reusable workflows to v5.0.0 instead of v4.1.0. The prepare workflow also switches its App input from app-id to client-id. The title names both the version bump and the client ID switch, so it covers the primary change. It is specific and does not use vague terms. Length is 60 characters and 12 words, which is acceptable for a title.

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. (3 skipped: 3 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 trail,
With carrots packed and ears set sail.
Three workflows hop to version five,
The client ID helps them arrive.
Dry-run notes the checks in view,
Then off the release bunnies flew.

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

@chhoumann
chhoumann merged commit 7ce9954 into master Oct 24, 2026
18 of 19 checks passed
@chhoumann
chhoumann deleted the ci/v5-client-id branch October 24, 2026 14:26
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