mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-12 05:36:40 +00:00
Environment Test
f37a2e57a3
Keep live registry lookups out of the default make test flow. Add a dedicated external suite, workflow, and docs so the check stays opt-in but still gates code CI when enabled.
39 lines
1.9 KiB
Markdown
39 lines
1.9 KiB
Markdown
# Lint 🔍
|
|
|
|
You MUST use these linting and quality tools where applicable:
|
|
|
|
- [ruff](https://github.com/astral-sh/ruff)
|
|
- [shellcheck](https://github.com/koalaman/shellcheck)
|
|
- [hadolint](https://github.com/hadolint/hadolint)
|
|
|
|
## Repository Lint Rules 📏
|
|
|
|
You MUST apply these repo-wide rules when you add, move, or review files:
|
|
|
|
- Keep broad folders shallow when that helps readability. Direct children SHOULD stay at 12 or fewer items per folder.
|
|
- Treat structural hubs such as `roles/`, `cli/`, `tests/unit/plugins/filter`, `tests/unit/roles`, `inventories/bundles/servers`, `inventories/bundles/workstations`, `plugins/filter`, `plugins/lookup`, `group_vars/all`, and `.github/workflows` as intentional exceptions when they are used to organize the tree.
|
|
- You SHOULD prefer smaller, more focused folders over dumping many unrelated files into one directory.
|
|
|
|
For refactoring guidance, see [Refactoring](../refactoring.md).
|
|
|
|
## Suppression Comments 🚫
|
|
|
|
Some lint checks can be suppressed on a per-item basis using inline comments.
|
|
You MUST use these only when the check genuinely does not apply.
|
|
You MUST NOT use them to silence legitimate issues.
|
|
For suppressions used by opt-in external checks, see [external.md](external.md).
|
|
|
|
| Comment | Placement | Affected test | Effect |
|
|
|---|---|---|---|
|
|
| `# noqa: shared` | Line directly above `shared:` in `config/main.yml` | [test_service_shared_consistency.py](../../../../tests/lint/ansible/test_service_shared_consistency.py) | Skips shared-consistency validation for that service |
|
|
| `# run_once_<key>: deactivated` | Inside the task file, on the task entry | [test_run_once_tags.py](../../../../tests/lint/ansible/test_run_once_tags.py) | Suppresses the run-once tag warning for that specific task key |
|
|
|
|
## Running Specific Lint Tests 🏃
|
|
|
|
Use `TEST_PATTERN` to scope the lint test run to a single file:
|
|
|
|
```bash
|
|
# Run lint tests for a specific file
|
|
TEST_PATTERN=test_my_role.py make test-lint
|
|
```
|