Skip to content

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

Assets 2
Loading