Skip to content

Releases: drevendev/BeautifulRepo

Release list

v0.2.0 — agent plugin and safer link checks

v0.2.0 — agent plugin and safer link checks Latest
Latest

Choose a tag to compare

View all tags
@github-actions github-actions released this 23 Oct 10:22
v0.2.0
4f06f26
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

v0.2.0 — agent plugin and safer link checks

What changed

BeautifulRepo's offline audit now ships as a Claude Code and Codex plugin you can pin. The link checkers and the GitHub Action got a security fix and are stricter in ways that match GitHub: they report wrong letter case, Windows-only names and heading anchors GitHub wouldn't generate. The repository itself gained release drafts, scheduled freshness checks, a linter, decision records and a real README before/after case.

Upgrade notes

  • Action adopters: move your pin to the v0.2.0 commit (GHSA-9rpm-g83x-47w7 affects Windows runners). The adoption guide shows the pinned line; check where a tag points with git ls-remote https://github.com/drevendev/BeautifulRepo refs/tags/v0.2.0.
  • Plugin users: claude plugin marketplace add drevendev/BeautifulRepo@v0.2.0 or codex plugin marketplace add drevendev/BeautifulRepo --ref v0.2.0, then install beautifulrepo@beautifulrepo (plugin guide).

Breaking changes

No inputs or outputs were removed, but stricter checks can turn a green run red. Each case names a link that is broken on GitHub:

  • Destinations with a backslash, a drive letter, a :, a trailing dot or space, or a Windows device name are reported as non-portable (#110, #114).
  • Wrong letter case is reported on Windows and macOS as on Linux (#114).
  • Section anchors follow GitHub's slugs, so #terms-conditions for ## Terms & Conditions now fails (#115).
  • The Action fails on an empty checks list or an invalid audit-fail-on (#109).

Added

  • Claude Code and Codex plugin with a read-only audit-repo skill (#90).
  • SECURITY.md backed by private vulnerability reporting (#94); Discussions for questions (#95).
  • Release drafts from tags (#119), review-date checks in the scheduled run (#122), a hash-pinned linter (#126).
  • AGENTS.md (#120), decision records (#125) and a real README before/after case (#124).

Changed

  • docs_links.py and html_navigation.py scan the current directory when --root is omitted, like repo_audit.py (#89).
  • The changelog follows Keep a Changelog sections from this release on (#118).
  • Agent docs no longer promise that nothing leaves the machine: the Python checks are offline, the agent session is not (#97, #117).

Fixed

  • Security: GHSA-9rpm-g83x-47w7: UNC paths in a checked repository no longer make the link checkers open a network share on Windows (#110).
  • The Action runs every validated check whatever separates the names (#109).
  • Junctions are not followed by the audit or the link-file walk (#110, #111).
  • Scanning time is bounded on adversarial Markdown (#112); odd line separators no longer crash html_navigation.py (#113); stray backticks no longer hide audit findings (#116).

Known issues

  • Installing the plugin from GitHub (rather than a local path) was not verified in either agent for this release.
  • macOS is not tested in CI; screen readers and real devices were not tested.
  • The Lint job is not yet a required check.

Verification

  • Tag / target commit: v0.2.0 / 4f06f26
  • Release publication date: 2026-10-23
  • Compared from: v0.1.0
  • Checks actually observed: required checks passed on 4f06f26: Python 3.11, Python 3.14, Python 3.14 (Windows), Action self-test (ubuntu-latest), Action self-test (windows-latest); CI run https://github.com/drevendev/BeautifulRepo/actions/runs/39938417201
  • Release assets verified: no separate assets; only GitHub's source archives, not verified separately

Links

Assets 2
Loading

v0.1.0: BeautifulRepo checks as a pinnable GitHub Action

v0.1.0: BeautifulRepo checks as a pinnable GitHub Action

Choose a tag to compare

View all tags
@drevendev drevendev released this 22 Oct 11:54
v0.1.0
96e04e6
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

What changed

Other repositories can now run BeautifulRepo's offline checks in their own CI with one step, without copying scripts. The checks are the README/license/contribution audit, repository-owned Markdown links, and local HTML destinations and section anchors:

- uses: drevendev/BeautifulRepo@96e04e6a79027354c5e84a4a28f3ba5f5441d484 # v0.1.0

This is also the first tagged version of the handbook itself: guides, templates, five tested starter examples and the offline tools described in the README.

Upgrade notes

This is the first release, so there is nothing to upgrade. Pin the full commit SHA above rather than the tag name, because a tag can be moved and a SHA cannot. The adoption guide covers inputs and rollout.

Breaking changes

None.

Added

  • Composite GitHub Action action.yml, with inputs path, checks, audit-fail-on and exclude. It uses the caller's Python 3.11+ and makes no network requests (#51).
  • Repeatable --exclude GLOB for tools/docs_links.py and tools/html_navigation.py, for vendored or archived Markdown (#51).
  • Adoption guide with a copy-paste workflow and a rollout without a wall of red (#51).
  • Maintainer handoff recipe (#48).

Changed

  • The link checkers never scan Markdown inside .git or node_modules. In a trial on seven local repositories, installed packages produced nearly all false findings (#51).

Fixed

  • Every documented check now passes on a Windows checkout. LF line endings are enforced, the curated starter writes UTF-8 output, and file-mode handling is portable (#50).

Known issues

  • The action is tested on Ubuntu and Windows runners, not macOS.
  • Findings appear in the job log, not as pull-request annotations.
  • These are bounded source checks, not a Markdown renderer, link crawler, security scanner or accessibility certification.
  • BeautifulRepo does not yet publish its own SECURITY.md or CODE_OF_CONDUCT.md (#30), and a real-repository adaptation case is still open (#32).

Verification

  • Tag / target commit: v0.1.0 / 96e04e6a79027354c5e84a4a28f3ba5f5441d484
  • Release publication date: 2026-10-22
  • Compared from: repository start (first tag)
  • Checks actually observed: CI run 39773902873 on that exact commit. Python 3.11, Python 3.14, Python 3.14 (Windows), Action self-test (ubuntu-latest) and Action self-test (windows-latest) all succeeded. The self-tests confirm that a broken link and an unknown check name fail. Locally, the identical tree passed 231 tests on Windows 11 with Python 3.14.7.
  • Release assets verified: no assets beyond GitHub's automatic source archives.

Links

Loading