Skip to content

docs(readme): document prebuilt CLI binary + dispatch release flow#25

Merged
stephane-segning merged 1 commit into
mainfrom
claude/readme-prebuilt
Jun 28, 2026
Merged

docs(readme): document prebuilt CLI binary + dispatch release flow#25
stephane-segning merged 1 commit into
mainfrom
claude/readme-prebuilt

Conversation

@stephane-segning

Copy link
Copy Markdown
Contributor

What

Update the top-level README to match the current architecture (the per-action READMEs were already reframed in #23).

  • New bullet — "Prebuilt CLI, not resolved at runtime": most actions download a checksum-verified binary per OS/arch (Linux x64/arm64, macOS arm64); no Dart SDK / no dart pub get per run. codegen / android-setup / ios-setup keep dart run (they set up Flutter anyway).
  • Reworded the self-hosted bullet: only the build/codegen actions read the Flutter toolchain from PATH; the rest run the prebuilt binary and need nothing.
  • New "Releasing the CLI" section: bump cli-version.txt, then dispatch the release-cli workflow from the Actions tab — no local git tag.

Why

The README still implied every action needs a toolchain on PATH and documented no release process, both stale after the prebuilt-binary + workflow_dispatch changes (#23, #24).

🤖 Generated with Claude Code

The top-level README still implied every action needs a Dart toolchain on PATH
and documented no release process. Reflect the current architecture:
- New 'Prebuilt CLI, not resolved at runtime' bullet (download a
  checksum-verified binary per OS/arch; codegen/*-setup keep dart run).
- Reword the self-hosted bullet: only build/codegen actions read the toolchain
  from PATH; the rest run the prebuilt binary and need nothing.
- New 'Releasing the CLI' section: bump cli-version.txt, then dispatch the
  release-cli workflow (no local git tag).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@stephane-segning
stephane-segning merged commit a54868d into main Jun 28, 2026
1 check passed

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README documentation to describe the transition to a prebuilt, checksum-verified CLI binary instead of resolving it at runtime, and adds instructions for releasing the CLI via a GitHub Actions workflow. The review feedback points out a minor inconsistency in the documentation regarding which actions require the Flutter toolchain on PATH versus those that run the prebuilt binary, and suggests a clearer phrasing.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md
Comment on lines +63 to +65
GitHub-hosted or self-hosted runners. The build/codegen actions read your
Flutter toolchain from PATH (with opt-in setup steps); the rest just run the
prebuilt CLI binary and need nothing on PATH.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

There is a slight inconsistency here. According to the new bullet point added in this PR, android-setup and ios-setup still use dart run (and thus require the Dart/Flutter SDK). However, this sentence states that "the rest [excluding build/codegen] just run the prebuilt CLI binary and need nothing on PATH", which incorrectly groups the setup actions into the category of actions that run the prebuilt binary and need nothing on PATH.

We should clarify this by distinguishing between build/codegen actions, setup actions, and the remaining utility/publishing actions.

Suggested change
GitHub-hosted or self-hosted runners. The build/codegen actions read your
Flutter toolchain from PATH (with opt-in setup steps); the rest just run the
prebuilt CLI binary and need nothing on PATH.
GitHub-hosted or self-hosted runners. The build/codegen actions read your
Flutter toolchain from PATH (with opt-in setup steps), while setup actions
configure it. The remaining publishing/utility actions run the prebuilt CLI
binary and need nothing on PATH.

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