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

windows development: info about module_utils and requires #32060

Merged
merged 4 commits into from
Nov 1, 2017
Merged

windows development: info about module_utils and requires #32060

merged 4 commits into from
Nov 1, 2017

Conversation

jborean93
Copy link
Contributor

SUMMARY

Adds info about #Requires and #AnsibleRequires as well as how to use module_utils.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

windows development

ANSIBLE VERSION
2.5

@ansibot
Copy link
Contributor

ansibot commented Oct 24, 2017

cc @dharmabumstead
click here for bot help

@ansibot ansibot added affects_2.5 This issue/PR affects Ansible v2.5 docs_pull_request needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Oct 24, 2017
@jborean93 jborean93 added windows Windows community and removed needs_triage Needs a first human triage before being processed. labels Oct 24, 2017
dharmabumstead
dharmabumstead suggested changes Oct 24, 2017
View reviewed changes
Copy link
Contributor

@dharmabumstead dharmabumstead left a comment •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Edited. Docs are good, but would really be better if they were fleshed out with specific command line and code examples rather than just high-level bullet points. Thanks @jborean93 - nice work!

dharmabumstead
dharmabumstead reviewed Oct 24, 2017
View reviewed changes
docs/docsite/rst/dev_guide/developing_modules_general_windows.rst


Windows unit testing
====================

Currently there is no mechanism to run unit tests for Powershell modules under Ansible CI.
There is work in the pipeline to introduce this in the future, stay tuned.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed. Please do not discuss possible upcoming features in the documentation. Feel free to ping me for further explanation.

@ansibot
Copy link
Contributor

ansibot commented Oct 24, 2017

The test ansible-test sanity --test rstcheck [?] failed with the following error:

docs/docsite/rst/dev_guide/developing_modules_general_windows.rst:102:0: Inline interpreted text or phrase reference start-string without end-string.

click here for bot help

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Oct 24, 2017
jborean93
jborean93 commented Oct 24, 2017
View reviewed changes
Copy link
Contributor Author

@jborean93 jborean93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dharmabumstead just one question regarding your changes. As for fleshing out the content we can always do that in time but my aim is to just get at least something out there for people to get started on.

docs/docsite/rst/dev_guide/developing_modules_general_windows.rst Outdated
- Legacy: General definitions and helper utilities for Ansible module.
- SID: Utilities used to convert a user or group to a Windows SID and vice versa.

For more details on any specific module utility and their requirements, please see the `Appendix: Ansible Module Utilities <http://docs.ansible.com/ansible/latest/dev_guide/developing_module_utilities.html>_` and the `Ansible
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link to the developing_module_utilities isn't really relevant to the PowerShell module_utils and probably will lead to confusing, do you mind if I remove it @dharmabumstead

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.

@ansibot ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Oct 24, 2017
@jborean93 jborean93 mentioned this pull request Oct 25, 2017
Closed
@ansibot ansibot added stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. stale_review Updates were made after the last review and the last review is more than 7 days old. labels Nov 1, 2017
@jborean93 jborean93 merged commit d43985a into ansible:devel Nov 1, 2017
@jborean93 jborean93 deleted the win-development branch November 1, 2017 21:15
@ansibot ansibot added docs This issue/PR relates to or includes documentation. and removed docs_pull_request labels Mar 4, 2018
@ansible ansible locked and limited conversation to collaborators Apr 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@dharmabumstead dharmabumstead dharmabumstead requested changes

@nitzmahone nitzmahone Awaiting requested review from nitzmahone

Assignees
No one assigned
Labels
affects_2.5 This issue/PR affects Ansible v2.5 docs This issue/PR relates to or includes documentation. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. stale_review Updates were made after the last review and the last review is more than 7 days old. 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.

None yet
3 participants
@jborean93 @ansibot @dharmabumstead