Chore: normalize plugin READMEs, regenerate artifacts, and fix whitespace (ANIT-1)
Merged
Stapel Dev opened 4 months ago

Summary

  • Normalized README structure across plugins to satisfy validator:
    • Ensured presence and naming of required sections: Description, Requirements, Variables, Usage.
  • Regenerated plugin artifacts via pre-commit:
    • Updated plugin index: plugins/PluginDirectory.md
    • Regenerated collections manifests: plugins/collections/requirements.yml and requirements.lock.yml
  • Fixed trailing whitespace and end-of-file formatting where necessary.

Key Changes

  • README updates:
    • configuration: docker_server, netbird/client, netbird/controller
    • core: refine_inventory
    • inventory: netbox_sync
    • maintenance: reboot_manager, updates
    • virtualization: opennebula_api_user, proxmox_sync
  • New plugin additions (Keycloak and NetBird):
    • configuration/keycloak: README, meta.yml, playbook.yml, docker files (.env.j2, docker-compose.yml.j2)
    • configuration/netbird/client: README, meta.yml, playbook, OS tasks (linux.yml, macos.yml, windows.yml)
    • configuration/netbird/controller: README, meta.yml, playbook, docker files (.env.j2, docker-compose.yml.j2, turnserver.conf.j2)
  • Generated artifacts:
    • plugins/PluginDirectory.md updated
    • plugins/collections/requirements.yml regenerated without pinned versions
    • plugins/collections/requirements.lock.yml regenerated

Validation

  • Pre-commit hooks: Passed
    • check yaml
    • fix end of files
    • trim trailing whitespace
    • plugins: validate metadata
    • plugins: generate requirements and index
    • plugins: ensure generated artifacts committed
    • plugins: validate README sections
    • plugins: validate meta.yml against JSON Schema
  • README validator: Clean (no missing sections)

Rationale

  • Standardized documentation layout improves discoverability and automated validation.
  • Generated artifacts are kept in sync to ensure deterministic CI and a consistent plugin index.
  • Formatting fixes avoid repeated pre-commit failures on future commits.

Notes

  • Requirements are currently unpinned in plugins/collections/requirements.yml as generated; pinning can be revisited if deterministic installs are desired.
  • Keycloak and NetBird plugins are introduced with initial scaffolding and configuration files, ready for iterative hardening.
Commits were merged into target branch
pull request 1/1
Submitter Stapel Dev
Target main
Source plugins
Assignees
Merge Strategy
Create Merge Commit
Watchers (1)
Reference
pull request ANIT-1
Please wait...
Connection lost or session expired, reload to recover
Page is in error, reload to recover