Repository navigation
Prepare for launch - #6
Conversation
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 15 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe PR prepares zsort for version 0.3.0. It adds version consistency checks, re-exports AST scanner symbols, expands CI across two Zig versions, adds cross-platform release automation, and updates release documentation. ChangesVersion 0.3.0 release infrastructure
Estimated code review effort: 3 (Moderate) | ~25 minutes Sequence Diagram(s)sequenceDiagram
participant Trigger as Tag or manual dispatch
participant Workflow as release.yml
participant Zig as Zig 0.16.0
participant GitHub as GitHub release
Trigger->>Workflow: start release workflow
Workflow->>Zig: build ReleaseFast binaries for four targets
Workflow->>Workflow: create compressed archives
Workflow->>Workflow: smoke-test Linux binary
Workflow->>GitHub: publish archives with generated notes
Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/release.yml:
- Line 5: Update the workflow_dispatch configuration and release logic to
require a tag input for manual runs, validate that tag against the project
version, and use the validated input as the release tag instead of relying on
github.ref. Preserve the existing tag behavior for non-manual triggers and
ensure mismatched manual tags prevent publication.
- Around line 3-4: The release workflow currently triggers on any tag starting
with 'v' without validating that the tag version matches the actual binary
version being published. Add a validation step early in the workflow that
extracts the version from github.ref_name, compares it against the output of
zsort --version, and fails the workflow with a clear error message if they do
not match. This ensures the published binaries have a version tag that
corresponds to their actual reported version.
- Around line 7-8: Restructure the release workflow into separate build and
publish jobs: keep checkout, setup, packaging, and tests in a job with contents:
read, then pass its artifacts to a publish job limited to contents: write.
Ensure only the publish job can use write permissions, and pin every action used
by both jobs to immutable commit SHAs.
In `@CHANGELOG.md`:
- Around line 11-19: Update the CHANGELOG release notes to accurately describe
the workflows: state that binary publishing and Homebrew tap bumps occur only
for v* tag pushes, clarify that Zig gates run on 0.15.2 and 0.16 while external
linters run only on 0.15.2, say the version is declared in both build.zig.zon
and src/version.zig with a build-time consistency check, and remove AGENTS.md
from the Added list.
In `@CONTRIBUTING.md`:
- Around line 92-94: Update the contribution instructions to identify the
version fields accurately: refer to `.version` in `build.zig.zon` and `version`
in `src/version.zig`, while preserving the remaining release steps.
In `@README.md`:
- Around line 46-47: Update the comment next to the v0.3.0 archive URL in the
dependency configuration example to document the complete zig fetch command
including that URL, or reference the release procedure in CONTRIBUTING.md
instead of showing only zig fetch --save.
In `@src/zsort.zig`:
- Line 9: Change the findLineEnd alias in zsort.zig to be publicly exported so
downstream code can access zsort.findLineEnd, matching the visibility of the
other re-exported symbols.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 419c32a7-1ed7-4130-8b21-5dd7c8272025
📒 Files selected for processing (9)
.github/workflows/ci.yml.github/workflows/release.ymlCHANGELOG.mdCONTRIBUTING.mdREADME.mdbuild.zigbuild.zig.zonsrc/version.zigsrc/zsort.zig
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/release.yml:
- Line 36: The direct interpolation of github.event.inputs.tag into the VERSION
assignment at line 36 creates a shell injection vulnerability. Move the
github.event.inputs.tag input to an environment variable (such as RELEASE_TAG)
at the job level, then update the VERSION assignment to use that environment
variable with parameter expansion (VERSION="${RELEASE_TAG#v}") to safely strip
the leading 'v' prefix. Additionally, restrict the workflow_dispatch trigger to
only run from trusted maintainers by setting appropriate permissions on the
workflow_dispatch event.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: e550777a-93a8-4d93-a8bd-aad904f62e54
📒 Files selected for processing (4)
.github/workflows/release.ymlCHANGELOG.mdCONTRIBUTING.mdREADME.md
🚧 Files skipped from review as they are similar to previous changes (3)
- CONTRIBUTING.md
- CHANGELOG.md
- README.md
1 participant
Summary by CodeRabbit
New Features
Documentation
Bug Fixes
Chores