mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 02:54:26 +00:00
kevinveenbirkenbachandClaude Opus 4.7
79409ebf10
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>
47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
# Shared Utilities (`utils/`)
|
|
|
|
This directory contains shared Python helpers used by custom modules and plugins.
|
|
|
|
## Purpose
|
|
|
|
Use `utils/` for reusable code that should not be duplicated across:
|
|
|
|
- `library/` modules,
|
|
- `plugins/action/`,
|
|
- `plugins/filter/`,
|
|
- `plugins/lookup/`.
|
|
|
|
Typical shared utilities:
|
|
|
|
- API clients,
|
|
- validation/conversion helpers,
|
|
- path and configuration helpers,
|
|
- cross-plugin/module domain logic.
|
|
- Shared HTTP(S) connection handler for multiple modules.
|
|
- Common validation or transformation functions for user input.
|
|
- Utility functions for interacting with Docker, LDAP, etc.
|
|
- Grouped helper packages such as `utils/domains/` for related domain logic.
|
|
|
|
## Design Guidelines
|
|
|
|
- Keep helpers focused and composable.
|
|
- Avoid side effects during import.
|
|
- Prefer explicit function/class APIs over implicit globals.
|
|
- Keep dependencies minimal so modules/plugins stay lightweight.
|
|
|
|
## Example Import
|
|
|
|
```python
|
|
from utils.domains.primary_domain import get_primary_domain
|
|
```
|
|
|
|
## What Does Not Belong Here
|
|
|
|
- Standalone executable modules (put in `library/`).
|
|
- Ansible plugin entrypoints (put in `plugins/*`).
|
|
|
|
## References
|
|
|
|
- Module utilities: <https://docs.ansible.com/ansible/latest/dev_guide/developing_module_utilities.html>
|
|
- Plugin development: <https://docs.ansible.com/ansible/latest/dev_guide/developing_plugins.html>
|