Skip to content

BenchBar 0.5.5

Choose a tag to compare

View all tags
@github-actions github-actions released this 26 Sep 11:33
· 11 commits to main since this release
v0.5.5
bd3a776
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

The project skin: BenchBar gets a manual, a front door and a way to
reach you. The documentation moves to its own site,
benchbar.akashmishra.com, built from docs/ with search and a page per
command; the README becomes a short front door; the repository gets the
files a project people contribute to needs; and the app gets an About
pane with an update check, a Help menu and Report a Bug.

App

  • About pane: the app's version and build, the command line tool's
    version and path (from benchbar --version), links to the docs, the
    release notes and the source, the license line and the trademark note.
  • Check for Updates in the About pane and the app menu: one request
    to GitHub's latest release, only when you click, with "up to date" or
    "0.6.0 available" and a button to the release page. Nothing is
    downloaded.
  • Help menu: BenchBar Documentation (⌘?), Keyboard Shortcuts, Release
    Notes and Report a Bug. The status item's right click menu has About
    and Documentation.
  • Report a Bug: a sheet explains what the zip holds (no secrets, no
    personal paths, no names), runs benchbar report --json, shows the zip
    in Finder and opens a new issue with the macOS and BenchBar versions
    filled in.
  • With no bench yet, the popover points at the Install guide, and its
    hint says benchbar adopt <path> for a bench you already have.
  • About BenchBar in the menus opens the About pane instead of the bare
    standard panel.

Command line

  • benchbar docs [TOPIC] opens the documentation site or a topic's page
    (install, quick-start, app, sites, apps, doctor, teams, agents, mcp,
    cli, json, runners, troubleshooting, config ...); --print prints the
    URL; benchbar docs --help lists the topics.
  • benchbar --help ends with the docs URL.
  • benchbar doctor prints a see: line with the check's section of the
    doctor guide under every [FAIL] (after its fix: line). The
    [OK], [WARN], [FAIL] and fix: lines and --json are unchanged.
  • benchbar --version adds the installed BenchBar app's version on a
    second line; the first line is unchanged.
  • benchbar report --json prints {"schema_version":1,"cli_version":..,"zip":PATH,"redactions":N}
    for the app and scripts (docs/json-schema.md).

Repo

  • CONTRIBUTING.md: the tests, bash 3.2 and shellcheck, idempotency,
    what a pull request needs (small, CHANGELOG, DECISIONS, tested on) and
    the AI policy. README's Contributing section now points to it.

  • CODE_OF_CONDUCT.md (Contributor Covenant 3.0) and SECURITY.md
    (private vulnerability reports, what counts, latest release supported).

  • Issue forms for bugs (macOS, version, install method, profile, the
    benchbar report zip, doctor output) and features, blank issues off
    with a link to Discussions Q&A, a pull request template with an AI
    disclosure line, CODEOWNERS, Dependabot for Actions and Swift, and a
    commented out FUNDING.yml.

  • docs/images/social-preview.png and docs/images/og-image.png, drawn
    by scripts/social-preview.swift from the icon, the light popover and
    the runner frames.

  • ROADMAP: Vouch under 1.0, once drive-by pull requests appear.

  • The Code of Conduct and the security policy give
    mail@akashmishra.com for people who cannot use GitHub.

Docs

  • A docs site at https://benchbar.akashmishra.com: Astro Starlight
    in site/, built with Bun from the markdown in docs/, with search,
    dark mode that follows the system, an edit link and the last updated
    date on every page. Start (Introduction, Install, Quick start, The menu
    bar app), Guides (Benches and sites, Apps, Doctor and repair, Teams,
    Coding agents and MCP), a CLI reference with one page per command group
    (flags, exit codes, an example each), Configuration, and the existing
    JSON schema, Runners, Troubleshooting, Decisions, Releasing and Testing
    pages. ROADMAP.md and CONTRIBUTING.md stay at the repo root and
    appear as /roadmap/ and /contributing/.

  • Every paragraph of the old README now lives in docs/, rewritten into
    those pages.

  • docs/guides/doctor-and-repair.md has a ### <check_id> heading for
    every doctor check, with what it checks and its fix, so
    /guides/doctor-and-repair/#<check_id> links land on the right check.

  • Every markdown file in docs/ has title and description
    frontmatter; the duplicate # headings are gone.

  • .github/workflows/docs.yml builds the site and checks its links on
    every pull request, and deploys it to GitHub Pages on a push to main
    that changed the docs. tests/test-docs.sh checks that every doctor
    check id has its heading, that every flag in the CLI reference exists in
    benchbar --help, and that every page has its frontmatter.

  • CI skips the CLI and app jobs when a change touches only docs/ or
    site/.

  • The command reference documents benchbar docs, --version and
    report --json; troubleshooting says how to turn the scheduler on.

Readme

  • README rewritten as the front door: logo and popover in light and dark,
    why, install, quick start, eight features and links into the new
    documentation site, about 800 words instead of 3,200. Everything it no
    longer says lives in the docs.

This build is not signed with an Apple Developer ID (ad hoc signature). macOS shows "Apple could not verify" on first open of the DMG: use System Settings > Privacy & Security > Open Anyway, or install with the one liner, which downloads with curl and opens without that prompt:

curl -fsSL https://raw.githubusercontent.com/askysh/benchbar/main/install.sh | bash

Checksums are in SHA256SUMS.

Assets 5
Loading