mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-12 21:56:21 +00:00
kevinveenbirkenbachandClaude Opus 5.5
6faa615135
Two store-i18n-only code paths predate updater's custom roles (web-app-cst-*,d92375922d), which the mergec9e7f950d9brought in: - utils/i18n/libretranslate.py deploys the translation tools lane with cli.administration.deploy.dedicated but without --skip-pull. The lane bind-mounts the checkout and its generated inventory declares no custom role, so `make i18n-translate` would have run pull_custom_roles and removed every pulled web-app-cst-* from the host's roles/. It now passes --skip-pull, as every other generated deploy does. - utils/i18n/extract.py role_messages globbed roles/*/meta/main.yml, including the gitignored custom roles, so a checkout with a pulled custom role failed test_core_catalogs_hold_exactly_the_current_sources and its remedy would have written the custom role's description into every tracked core catalog, against updater's rule that core never tracks custom roles. It now skips is_custom(role), like the README generators. test_a_pulled_custom_role_stays_out_of_the_core_catalogs pins the second point; without the skip it fails with the custom role in the list. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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