Skip to content

docs: correct schemes-field comment in websites.yml#15

Merged
ericcames merged 1 commit into
mainfrom
11-drop-stale-schemes-comment
May 21, 2026
Merged

docs: correct schemes-field comment in websites.yml#15
ericcames merged 1 commit into
mainfrom
11-drop-stale-schemes-comment

Conversation

@ericcames

@ericcames ericcames commented May 21, 2026

Copy link
Copy Markdown
Owner

Summary

Closes #11.

The header comment in playbooks/files/websites.yml claimed:

schemes: list of schemes to probe; defaults to [https] if omitted

But that default was never implemented — playbooks/main.yml uses websites | subelements('schemes'), which hard-fails if any entry omits the schemes field. Every entry has always declared it explicitly.

Replace the aspirational text with (required) so readers don't believe in a default that won't work.

Files

  • playbooks/files/websites.yml — one comment line corrected
  • CHANGELOG.md — entry under [Unreleased] / Changed

Test plan

  • yamllint clean locally
  • ansible-lint clean locally
  • CI green on PR

🤖 Generated with Claude Code

The schema header comment claimed schemes defaults to [https] if omitted,
but no default was ever implemented — playbooks/main.yml uses
`subelements('schemes')`, which hard-fails on entries missing the field.
Replace the aspirational text with `(required)` so readers don't believe
in a default that won't work.

Refs #11.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@ericcames ericcames added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 21, 2026
@ericcames
ericcames merged commit 599e620 into main May 21, 2026
2 checks passed
@ericcames
ericcames deleted the 11-drop-stale-schemes-comment branch May 21, 2026 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation good first issue Good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Drop misleading 'defaults to [https] if omitted' comment in websites.yml

1 participant