Skip to content

Update deps, improve GH Actions security per zizmor, update install command and v2 info - #16

Merged
ocean merged 7 commits into
mainfrom
develop
Aug 21, 2026
Merged

Update deps, improve GH Actions security per zizmor, update install command and v2 info#16
ocean merged 7 commits into
mainfrom
develop

Conversation

@ocean

@ocean ocean commented Aug 21, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation

    • Improved Linux installation instructions to support ARM architectures and clearly report unsupported systems.
    • Clarified that the installation commands install Ahoy v3.
    • Added v2 compatibility guidance, including a download command for Ahoy v2.5.0.
  • Bug Fixes

    • Prevented unsupported Linux architectures from incorrectly defaulting to amd64 during installation.

ocean added 7 commits August 20, 2026 21:41
The workflow used bun-version: latest, leaving the build runtime
unpinned while every action around it is pinned to a commit SHA.
Pin to 1.3.14 to match local development and keep builds reproducible.
zizmor flagged excessive-permissions: the workflow declared per-job
permissions but had no workflow-level default, so it inherited the
runner default. Both jobs already declare what they need, so denying
by default at the top level costs nothing.
Replace the hand-rolled "pip install zizmor && zizmor ." step with
zizmorcore/zizmor-action pinned to v0.6.2 (bundles zizmor 1.29.0).

The pip install was unpinned, making the security scanner the one
unpinned link in an otherwise SHA-pinned chain. Results also went
nowhere with only contents: read, so add security-events: write to
upload SARIF to code scanning.
v3.0.0 publishes ahoy-bin-linux-armv7 and ahoy-bin-linux-armv6
alongside amd64 and arm64, but the install one-liner only detected
the latter two. Add cases for both, and match armv8* to arm64.

Also replace the "*) echo amd64" catch-all with an explicit error.
Previously an unrecognised machine silently downloaded the amd64
binary, which then failed to execute; it now aborts before wget with
a clear message rather than installing an unusable binary.

Patterns are parenthesised so the case survives zsh command
substitution; verified the one-liner parses under sh, bash, zsh
and dash.
homebrew-core moved the ahoy formula to 3.0.0, so brew install ahoy
no longer yields v2. The Linux one-liner is affected too, since it
downloads from /releases/latest/.

Add an aside to the installation section covering both: v3 is
intended to be backwards compatible with existing v2 .ahoy.yml
files, and anyone who still needs v2 should take v2.5.0 from the
GitHub releases page. There is no ahoy@2 formula, so that is the
only route to v2 on macOS as well as Linux.

Note the v2 assets are named differently to v3 (ahoy-bin-linux-arm
rather than the armv6/armv7 split), so the pinned-tag URL is given
rather than reusing the command above.
@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 993fa23b-ce66-45ba-b3a4-913de0ce225b

📥 Commits

Reviewing files that changed from the base of the PR and between 6ae1317 and 5760e6f.

📒 Files selected for processing (4)
  • .github/workflows/deploy-docs.yml
  • .github/workflows/zizmor.yml
  • .gitignore
  • src/content/docs/guides/getting-started.mdx

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


Walkthrough

The workflows now set explicit permissions and pinned tool versions. The repository ignores .artifacts/. The installation guide now handles Linux architectures and documents Ahoy v2 and v3 options.

Changes

Repository maintenance

Layer / File(s) Summary
Workflow controls and artefact exclusion
.github/workflows/deploy-docs.yml, .gitignore
The documentation deployment workflow denies permissions by default and pins Bun to 1.3.14. The repository ignores /.artifacts/.
Zizmor permissions and action
.github/workflows/zizmor.yml
The zizmor job requests SARIF upload and repository read permissions. It uses zizmorcore/zizmor-action v0.6.2.
Installation architecture and version guidance
src/content/docs/guides/getting-started.mdx
The Linux installer selects binaries for supported architectures and reports unsupported architectures. The guide documents Ahoy v2 compatibility and v3 installation options.

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

Merge Risk: ⚪ Minimal · up to 5760e

The PR updates install/version guidance and GitHub Actions configuration; the documented ARM mappings and v3 release note remain valid. No actionable merge-blocking risk remains beyond normal checks.

Poem

A rabbit checked the workflow gate,
Pinned Bun neatly at the right rate.
“No stray artefacts here,”
It said with a cheer,
“And every platform knows its fate!”

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarises the workflow security updates, dependency pinning, installation command changes, and v2 documentation added in the pull request.
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 files. (4 skipped: 4 unsupported.)
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 develop

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

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

@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@ocean
ocean merged commit e1e2290 into main Aug 21, 2026
11 checks passed
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.

2 participants