Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

win_template - use shared doc fragment for shared options #59701

Merged
merged 2 commits into from
Jul 30, 2019
Merged

win_template - use shared doc fragment for shared options #59701

merged 2 commits into from
Jul 30, 2019

Conversation

jborean93
Copy link
Contributor

SUMMARY

Moves most of the template documentation options to a doc fragment so we can share the same documentation between template and win_template. Both these action plugins share the same plugin code so the majority of the options are the same except for slightly different defaults.

Also adds tests for the output_encoding option to win_template just for completeness.

Fixes #59504

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

template
win_template

@ansibot
Copy link
Contributor

ansibot commented Jul 29, 2019

cc @ShachafGoldstein @if-meaton @jhawkesworth @nitzmahone
click here for bot help

@ansibot ansibot added affects_2.9 This issue/PR affects Ansible v2.9 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. files Files category module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. new_plugin This PR includes a new plugin. support:community This issue/PR relates to code supported by the Ansible community. support:core This issue/PR relates to code supported by the Ansible Engineering Team. windows Windows community labels Jul 29, 2019
@ansibot
Copy link
Contributor

ansibot commented Jul 29, 2019

cc @ShachafGoldstein @if-meaton @jhawkesworth @nitzmahone
click here for bot help

@ansibot

This comment has been minimized.

Sign in to view
@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Jul 29, 2019
@ansibot

This comment has been minimized.

Sign in to view
@ansibot
Copy link
Contributor

ansibot commented Jul 29, 2019

The test ansible-test sanity --test validate-modules [explain] failed with 2 errors:

lib/ansible/modules/windows/win_template.py:0:0: E309 version_added for new option (lstrip_blocks) should be '2.9'. Currently StrictVersion ('2.6')
lib/ansible/modules/windows/win_template.py:0:0: E309 version_added for new option (output_encoding) should be '2.9'. Currently StrictVersion ('2.7')

click here for bot help

@ansibot ansibot added the ci_verified Changes made in this PR are causing tests to fail. label Jul 29, 2019
@jborean93
Copy link
Contributor Author

Cannot fix the above sanity test as those options are available for win_template they were just never documented. Once merged this issue will go away.

@ansibot
Copy link
Contributor

ansibot commented Jul 29, 2019

The test ansible-test sanity --test validate-modules [explain] failed with 2 errors:

lib/ansible/modules/windows/win_template.py:0:0: E309 version_added for new option (lstrip_blocks) should be '2.9'. Currently StrictVersion ('2.6')
lib/ansible/modules/windows/win_template.py:0:0: E309 version_added for new option (output_encoding) should be '2.9'. Currently StrictVersion ('2.7')

click here for bot help

@jborean93 jborean93 merged commit 652bfc7 into ansible:devel Jul 30, 2019
@jborean93 jborean93 deleted the win_template-doc branch July 30, 2019 22:05
jborean93 added a commit to jborean93/ansible that referenced this pull request Jul 30, 2019
@jborean93
win_template - use shared doc fragment for shared options (ansible#59701
48cc9a1 
)

* win_template - use shared doc fragment for shared options

* Change smart quote to em dash and fix whitespace issue

(cherry picked from commit 652bfc7)
@jborean93 jborean93 mentioned this pull request Jul 30, 2019
Merged
@jborean93
Copy link
Contributor Author

Backport PR to stable-2.8 #59828.

@sivel sivel removed the needs_triage Needs a first human triage before being processed. label Jul 31, 2019
@ansible ansible locked and limited conversation to collaborators Aug 27, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
affects_2.9 This issue/PR affects Ansible v2.9 ci_verified Changes made in this PR are causing tests to fail. docs This issue/PR relates to or includes documentation. files Files category module This issue/PR relates to a module. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. new_plugin This PR includes a new plugin. support:community This issue/PR relates to code supported by the Ansible community. support:core This issue/PR relates to code supported by the Ansible Engineering Team. windows Windows community
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

win_template and win_copy with content should support encoding
3 participants
@jborean93 @ansibot @sivel