mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-07 03:15:56 +00:00
Tooling integration
* add .markdownlint-cli2.jsonc, .ansible-lint, .ansible-lint-ignore
configs (permissive day-1: cosmetic rules disabled, semantic ones on)
* extend scripts/install/lint.sh with generic install_pip_pkg helper +
ensure_ansible_lint / ensure_galaxy_importer / ensure_markdownlint_cli2
ensure_* functions (pip / npm with sudo / --user / --break-system-packages
fallbacks). install_ansible_tools now also pulls ansible-lint and
galaxy-importer; new `markdown` install group.
* extend scripts/lint/ansible.sh to run ansible-lint after the existing
syntax-check.
* add scripts/lint/markdown.sh and scripts/lint/galaxy.sh runners. The
galaxy runner parallelizes via xargs (-P=$(nproc)), prints OK/FAIL per
role, and treats `bare-name dependency` errors as success since our
roles/ tree is not a Galaxy collection layout. All other Galaxy schema
errors still fail.
* Makefile: new lint-markdown and lint-galaxy targets, both wired into
`make lint`.
* CI: new workflows lint-markdown.yml and lint-galaxy.yml; lint-ansible.yml
now installs ansible-core + ansible-lint; ci-orchestrator wires both
new lint workflows into lint-gate.
Galaxy schema fixes
* shorten the canonical `galaxy_info.company` block from three lines to
two ("Kevin Veen-Birkenbach\nhttps://www.veen.world", 45 chars) so it
stays under Galaxy's hard 50-char limit. Updated everywhere: 229 role
meta/main.yml plus _CANONICAL_COMPANY in
tests/lint/repository/test_role_meta_main_galaxy_schema.py.
* shorten 19 over-long role descriptions to <=255 chars.
* add stub READMEs for sys-svc-compose-ca and sys-utils-service-loader.
Markdown baseline fixes
* markdownlint-cli2 --fix run repo-wide (formatting normalization
across CHANGELOG, role READMEs, docs).
* manual MD041 fixes: prepend H1 in 15 files (CHANGELOG, LICENSE,
TODO.md helpers, role README templates, etc.).
* MD025 / MD003 / MD001 / MD032 manual fixes for heading-style and
list-spacing edge cases.
* role README content polish: "## Single Point of Truth (SPOT)" headings
renamed to "## User data resolution" (D3 self-label rule).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
3.2 KiB
3.2 KiB
Branch 🌿
CI Impact 🔀
The branch prefix MUST match the type of change. The PR workflow uses it to classify the scope and decide which CI pipeline to run.
| Branch prefix | Scope | Matching files | CI behavior |
|---|---|---|---|
agent |
Changes to agent instructions or prompts | AGENTS.md, CLAUDE.md, GEMINI.md, docs/agents/* |
Skips ci-orchestrator, finishes green through the lightweight scope gate. |
documentation |
Documentation-only changes | **/*.md, **/*.rst (outside agent paths) |
Skips ci-orchestrator, finishes green through the lightweight scope gate. |
feature |
New features or enhancements | * |
Runs the full ci-orchestrator pipeline. |
fix |
Bug fixes | * |
Runs the full ci-orchestrator pipeline. |
update |
Automated or maintenance updates | * |
Runs the full ci-orchestrator pipeline. |
chore |
Maintenance, dependency, and tooling updates (incl. branches created by update.yml) | * |
Runs the full ci-orchestrator pipeline. |
alert-autofix |
Automated alert-triggered fixes | * |
Runs the full ci-orchestrator pipeline. |
dependabot |
Automated dependency updates | * |
Runs the full ci-orchestrator pipeline. |
Enforcement 🔒
All rules in this document are actively enforced on main via GitHub branch protection. See branch.md for the full enforcement policy.
Naming Conventions 🏷️
The description MUST use kebab-case (lowercase words separated by hyphens) and SHOULD be short enough to read at a glance.
The full branch name MUST follow one of the patterns below, depending on whether the change targets a specific role or is general:
| Case | Pattern | Example |
|---|---|---|
| General feature | feature/<topic> |
feature/ldap-integration |
| Role feature | feature/<role>/<topic> |
feature/web-app-matomo/ldap-integration |
| General fix | fix/<topic>/<ticket-id> |
fix/dns-resolution/taiga-123 |
| Role fix | fix/<role>/<topic>/<ticket-id> |
fix/web-app-matomo/login-redirect/taiga-789 |
| General update | update/<topic> |
update/docker-image-versions |
| Chore | chore/<topic> |
chore/update-docker-image-versions |
| Alert autofix | alert-autofix-<alert-id> |
alert-autofix-261 |
| Documentation | documentation/<topic> |
documentation/contributing-setup |
| Agent | agent/<topic> |
agent/improve-commit-instructions |
| Dependabot | dependabot/<ecosystem>/<dependency> |
dependabot/pip/requests-2.32.0 |
feature, update, documentation, and agent branches MUST NOT reference a ticket ID.
alert-autofix branches reference the alert ID instead of a ticket ID.
dependabot branches are created automatically and MUST NOT be renamed.