Skip to content

docs: document AUR install channel in README, site, and changelog#36

Merged
kjanat merged 1 commit into
masterfrom
worktree-aur-readme-site
Jun 3, 2026
Merged

docs: document AUR install channel in README, site, and changelog#36
kjanat merged 1 commit into
masterfrom
worktree-aur-readme-site

Conversation

@kjanat
Copy link
Copy Markdown
Owner

@kjanat kjanat commented Jun 3, 2026

Summary

Closes the gap left by #35 — the AUR packages are live but neither the
README, the landing site, nor the changelog mentioned them.

  • README.md ## Install: yay -S runner-run-bin added to the
    top-tier list (alongside npm and cargo binstall). Source variant
    yay -S runner-run slotted into the collapsed Other install methods
    block, next to the cargo install entries.
  • site/src/index.html: new arch · aur · primary copy-button
    between cargo · binstall · primary and cargo · build from source;
    same markup pattern as the existing buttons.
  • CHANGELOG.md [Unreleased]: ### Added describes the two AUR
    packages, the four-shell completion install paths, the workflow, and the
    prepare script. ### Security documents the action-SHA pinning sweep
    and the persist-credentials hardening from
    feat(aur): publish runner-run + runner-run-bin with shell completions #35.

Test plan

  • HTML well-formed: `` open/close balanced (7=7 across the file).
  • README install section renders the three primary install options in order and the collapsed source-build alternatives.
  • CHANGELOG follows the existing Keep-a-Changelog style (Added/Security under `[Unreleased]`, post-release checklist preserved at the bottom of the section).
  • Site visual check — confirm the new button wraps cleanly on the existing layout (no local build attempted; user verification on `bun run dev` if desired).

- README.md: yay -S runner-run-bin in top-tier install methods;
  runner-run (source) in the collapsed details block.
- site/src/index.html: arch · aur · primary button alongside the
  other prebuilt-binary primaries.
- CHANGELOG.md: Unreleased section with Added (AUR packages,
  completions, workflow, prepare script) and Security (action SHA
  pinning, persist-credentials hardening) entries.
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
runner 430841b Commit Preview URL

Branch Preview URL
Jun 03 2026, 06:11 PM

@coderabbitai coderabbitai Bot added the documentation Improvements or additions to documentation label Jun 3, 2026
@kjanat kjanat self-assigned this Jun 3, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 3, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

Arrr, this PR be a tidy wee patch that announces AUR package support for runner-run across three fronts! The changelog documents the new AUR packaging, shell completion installations, and security enhancements (GitHub Actions uses-pinning and credential handling). README gets updated with both binary (runner-run-bin) and source (runner-run) installation options via yay for Arch users. Finally, the website install button gets a matching AUR option so users can copy the yay command directly. All changes be consistent and focused on makin' AUR distribution transparent to users.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

  • kjanat/runner#35: Implements the aur-prepare.sh strict semver validation, pkgver/pkgrel rewriting, and per-arch sha256sums_* injection directly referenced in this PR's changelog entries.

Suggested labels

documentation


✨ Shiny AUR packages now documented with care,
Binary and source builds floating everywhere,
Arch users be cheerin' from shore to sea,
A changelog, a README, and buttons so free~ 🏴‍☠️ ✨

🚥 Pre-merge checks | ✅ 8
✅ Passed checks (8 passed)
Check name Status Explanation
Title check ✅ Passed The title follows conventional commit guidelines with a lowercase verb prefix ('docs:') and clearly describes the main changes: documenting AUR install channels across README, site, and changelog.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Changelog Update ✅ Passed No source code files were modified—only documentation (README, HTML template, changelog). These fall under the check exclusions, so the CHANGELOG requirement does not apply.
Semver Version Bump Validation ✅ Passed PR #36 only modifies documentation and website markup (excluded by check). No source code files were modified, so version bump requirement does not apply.
Agents.Md Documentation Updated ✅ Passed No AGENTS.md exists in repository; PR only documents AUR packages in README, CHANGELOG, HTML—no architecture, workflow, automation, CLI, or agent-logic changes.
Description check ✅ Passed Pull request description is directly related to the changeset, detailing documentation updates for AUR packages across README, site, and changelog with clear implementation details.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch worktree-aur-readme-site

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

@kjanat kjanat merged commit bd0710c into master Jun 3, 2026
15 checks passed
@kjanat kjanat deleted the worktree-aur-readme-site branch June 3, 2026 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant