Skip to content

docs(oss): the notify example must use gh api -f, not -F - #269

Merged
wmadden-electric merged 1 commit into
mainfrom
docs/release-automation-raw-fields
Sep 14, 2026
Merged

wmadden-electric merged 1 commit into
mainfrom
docs/release-automation-raw-fields

Conversation

@wmadden-electric

Copy link
Copy Markdown
Contributor

docs/oss/release-automation.md shows product repositories how to send the product-published dispatch with gh api ... -F 'client_payload[package]=@prisma/composer-cli'. -F reads a value that starts with @ from a file, so that line fails with open prisma/composer-cli: no such file or directory before any request is made. prisma/composer#295 copied the example verbatim and its review bot caught it. -f sends the literal string.

Two characters changed; no code.

🤖 Generated with Claude Code

gh api -F reads a value that starts with @ from a file, so
'@prisma/composer-cli' fails to parse before any request is made. A
product repository that copies the example verbatim never sends the
dispatch (prisma/composer#295 did exactly that). -f sends the literal
string.

Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 14, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 4c15a341-4d36-4445-8585-e3efc981e453

📥 Commits

Reviewing files that changed from the base of the PR and between 52d6840 and 2fb1707.

📒 Files selected for processing (1)
  • docs/oss/release-automation.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


Summary by CodeRabbit

  • Bug Fixes
    • Improved release notifications so package and version details are preserved accurately when publishing products.
    • Prevented version values from being unintentionally expanded, keeping notification payloads informational and consistent.

Walkthrough

The release automation documentation updates the publish workflow notification command. The command now uses -f for the client_payload[package] and client_payload[version] fields instead of -F. This prevents gh from expanding $VERSION before the repository_dispatch event is sent.

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to 2fb17

This documentation-only change has no established merge risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation change and the required switch from gh api -F to gh api -f.
Description check ✅ Passed The description accurately explains the documentation issue, the @ file-path interpretation, and the intended fix.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/release-automation-raw-fields
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/release-automation-raw-fields

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

@pkg-pr-new

pkg-pr-new Bot commented Sep 14, 2026

Copy link
Copy Markdown

Open in StackBlitz

npx https://pkg.pr.new/@prisma/cli@269
npx https://pkg.pr.new/@prisma/cli-engine@269

commit: 2fb1707

@wmadden-electric
wmadden-electric merged commit 6402dae into main Sep 14, 2026
16 checks passed
@wmadden-electric
wmadden-electric deleted the docs/release-automation-raw-fields branch September 14, 2026 14:51
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