Skip to content

docs: fix broken quoting in postfix_files defaults#239

Merged
richm merged 1 commit into
linux-system-roles:mainfrom
tmzullinger:fix-postfix_files-comments
Jun 9, 2026
Merged

docs: fix broken quoting in postfix_files defaults#239
richm merged 1 commit into
linux-system-roles:mainfrom
tmzullinger:fix-postfix_files-comments

Conversation

@tmzullinger

@tmzullinger tmzullinger commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

The comment added to defaults/main.yml for postfix_files in 73b7c72 (Added postfix_files feature as a simple means to add extra files/maps to the postfix config, 2024-06-09) included unneeded quotes. One of them was unclosed. Rather than add the closing quote, drop them to match the example provided in README.md.

Adjust the address used in the content field of the README.md example to match what's used elsewhere in the examples. The commented variable in defaults and the README now contain the same data.

Summary by CodeRabbit

  • Documentation
    • Updated example configuration entries for postfix_files and optional Postfix maps
    • Refined formatting and placeholder examples in documented code snippets

The comment added to `defaults/main.yml` for `postfix_files` in 73b7c72
(Added postfix_files feature as a simple means to add extra files/maps
to the postfix config, 2024-06-09) included unneeded quotes.  One of
them was unclosed.  Rather than add the closing quote, drop them to
match the example provided in `README.md`.

Adjust the address used in the content field of the `README.md` example
to match what's used elsewhere in the examples.  The commented variable
in defaults and the README now contain the same data.

Signed-off-by: Todd Zullinger <tmz@pobox.com>
@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR updates example configuration values and formatting in the Postfix Ansible role documentation. The sender_canonical_maps example in README is changed from mapping to info@example.com to user@example.com, and commented Postfix map examples in defaults are reformatted for consistency.

Changes

Documentation and example updates

Layer / File(s) Summary
Example configuration updates
README.md, defaults/main.yml
Updated sender_canonical_maps example mapping value in README from info@example.com to user@example.com. Reformatted commented Postfix map examples in defaults for sasl_passwd and sender_canonical_maps with adjusted quoting and placeholder formatting.
🚥 Pre-merge checks | ✅ 4 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description Format ⚠️ Warning PR description lacks required template sections: missing "Enhancement:" or "Feature:", "Reason:", and "Result:" labels as defined in .github/pull_request_template.md Reformat description to include: Enhancement: (what changed), Reason: (why), Result: (outcome), and optional Issue Tracker Tickets sections.
Description check ❓ Inconclusive The description provides detailed context but doesn't follow the required template structure with Enhancement/Reason/Result sections. Restructure the description to follow the template: Enhancement (what was fixed), Reason (why), and Result (expected outcome).
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The PR title 'docs: fix broken quoting in postfix_files defaults' follows the Conventional Commits format with a valid 'docs' type and clearly describes the main change: fixing quoting issues in postfix_files documentation.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@richm richm changed the title fix broken quoting in postfix_files defaults docs: fix broken quoting in postfix_files defaults Jun 9, 2026
@richm
richm merged commit c4fda0a into linux-system-roles:main Jun 9, 2026
28 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants