daniel/ansible-bind9-role
1
0
Fork 0
Code Issues 3 Pull Requests 1 Actions Releases Wiki Activity

docs: Clarify implemented vs planned features for BIND9 9.20 support #15

New Issue
Open
opened 2026-02-07 23:08:23 +00:00 by daniel · 0 comments
daniel commented 2026-02-07 23:08:23 +00:00
Owner
Copy Link

Description

The docs/BIND9_9.20_SUPPORT.md documentation includes sections describing runtime version detection and template conditionals that are planned features rather than currently implemented functionality.

Current Issue

Users reading the documentation may expect:

  • bind9_version variable to be automatically set at runtime
  • Template conditionals to handle version-specific configurations
  • Version detection code examples in tasks/main.yml

However, the actual implementation strategy uses versioned branches instead:

  • main branch: BIND9 9.18.x (LTS) - hardcoded for 9.18.x
  • 9.20 branch: BIND9 9.20+ - hardcoded for 9.20+
  • No runtime version detection needed
  • No template conditionals required

Solution

Update documentation to:

  1. Clarify that versioned branches approach eliminates need for runtime detection
  2. Move "Implementation Details" section to "Planned Future Enhancements" if runtime detection becomes needed
  3. Add note explaining why branch-per-version is preferred
  4. Document the versioned branch strategy more clearly
  5. Update task/main.yml section to reference actual current implementation

Related Issues

  • PR #14: Comments explaining this design decision

Tasks

  • Update docs/BIND9_9.20_SUPPORT.md to clarify versioned branch strategy
  • Add section explaining why runtime detection is not implemented
  • Update "Implementation Details" to show actual current code structure
  • Add future enhancements section if runtime detection is ever needed
  • Review other docs for similar clarity issues
## Description The docs/BIND9_9.20_SUPPORT.md documentation includes sections describing runtime version detection and template conditionals that are planned features rather than currently implemented functionality. ## Current Issue Users reading the documentation may expect: - `bind9_version` variable to be automatically set at runtime - Template conditionals to handle version-specific configurations - Version detection code examples in tasks/main.yml However, the actual implementation strategy uses **versioned branches** instead: - `main` branch: BIND9 9.18.x (LTS) - hardcoded for 9.18.x - `9.20` branch: BIND9 9.20+ - hardcoded for 9.20+ - No runtime version detection needed - No template conditionals required ## Solution Update documentation to: 1. Clarify that versioned branches approach eliminates need for runtime detection 2. Move "Implementation Details" section to "Planned Future Enhancements" if runtime detection becomes needed 3. Add note explaining why branch-per-version is preferred 4. Document the versioned branch strategy more clearly 5. Update task/main.yml section to reference actual current implementation ## Related Issues - PR #14: Comments explaining this design decision ## Tasks - [ ] Update docs/BIND9_9.20_SUPPORT.md to clarify versioned branch strategy - [ ] Add section explaining why runtime detection is not implemented - [ ] Update "Implementation Details" to show actual current code structure - [ ] Add future enhancements section if runtime detection is ever needed - [ ] Review other docs for similar clarity issues
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
No items
No Label
Milestone
No items
No Milestone
Assignees
Clear assignees
daniel
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: daniel/ansible-bind9-role#15
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?