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

include_role module docs list 'None' as default for private parameter #21077

Closed
wenottingham opened this issue Feb 6, 2017 · 1 comment · Fixed by #39566
Closed

include_role module docs list 'None' as default for private parameter #21077

wenottingham opened this issue Feb 6, 2017 · 1 comment · Fixed by #39566
Labels
affects_2.2 This issue/PR affects Ansible v2.2 bug This issue/PR relates to a bug. has_pr This issue has an associated PR. include_role support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
include and import issues

Comments

@wenottingham
Copy link
Contributor

ISSUE TYPE
  • Bug Report
COMPONENT NAME

include_role

ANSIBLE VERSION
ansible 2.2.1.0
  config file = /etc/ansible/ansible.cfg
  configured module search path = Default w/o overrides

(also devel)

CONFIGURATION
OS / ENVIRONMENT

CentOS 7, Fedora

SUMMARY

include_role takes a private parameter, described as:
"If True the variables from defaults/ and vars/ in a role will not be made available to the rest of the play."

module docs list the default as 'None', which is ambiguous. Presumably the default is actually one of 'True' or 'False'.

STEPS TO REPRODUCE
  1. look at docs.
@ansibot ansibot added affects_2.2 This issue/PR affects Ansible v2.2 bug_report module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. labels Feb 6, 2017
@alikins
Copy link
Contributor

alikins commented Feb 6, 2017

Not sure what the docs should say here. The 'default=None" kind of matches lib/ansible/playbook/role_include.py.IncludeRole's _private attribute

_private = FieldAttribute(isa='bool', default=None, private=True)

@alikins alikins removed the needs_triage Needs a first human triage before being processed. label Feb 6, 2017
@ansibot ansibot added the support:core This issue/PR relates to code supported by the Ansible Engineering Team. label Jun 29, 2017
@bcoca bcoca mentioned this issue Oct 20, 2017
Closed
@ansibot ansibot removed the module This issue/PR relates to a module. label Nov 23, 2017
@ansibot ansibot added bug This issue/PR relates to a bug. and removed bug_report labels Mar 1, 2018
@sivel sivel added this to Pending in include and import issues Apr 30, 2018
sivel added a commit to sivel/ansible that referenced this issue May 1, 2018
@sivel
Set default=no in import_role and include_role for private. Fixes ans…
b845031 
…ible#21077
@sivel sivel mentioned this issue May 1, 2018
Merged
@sivel sivel moved this from Triage to In Progress in include and import issues May 1, 2018
@sivel sivel added the has_pr This issue has an associated PR. label May 1, 2018
include and import issues automation moved this from In Progress to Done May 1, 2018
sivel added a commit that referenced this issue May 1, 2018
@sivel
Set default=no in import_role and include_role for private. Fixes #21077
65049b6 
 (#39566)
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this issue May 12, 2018
@sivel
Set default=no in import_role and include_role for private. Fixes ans…
692af2e 
…ible#21077 (ansible#39566)
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this issue May 14, 2018
@sivel
Set default=no in import_role and include_role for private. Fixes ans…
f879447 
…ible#21077 (ansible#39566)
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this issue May 14, 2018
@sivel
Set default=no in import_role and include_role for private. Fixes ans…
2f73ac7 
…ible#21077 (ansible#39566)
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this issue May 15, 2018
@sivel
Set default=no in import_role and include_role for private. Fixes ans…
f88c84b 
…ible#21077 (ansible#39566)
oolongbrothers pushed a commit to oolongbrothers/ansible that referenced this issue May 15, 2018
@sivel
Set default=no in import_role and include_role for private. Fixes ans…
0785a19 
…ible#21077 (ansible#39566)
ilicmilan pushed a commit to ilicmilan/ansible that referenced this issue Nov 7, 2018
@sivel @ilicmilan
Set default=no in import_role and include_role for private. Fixes ans…
1950c27 
…ible#21077 (ansible#39566)
@ansible ansible locked and limited conversation to collaborators May 7, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
affects_2.2 This issue/PR affects Ansible v2.2 bug This issue/PR relates to a bug. has_pr This issue has an associated PR. include_role support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
include and import issues
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update docs to set default=no in import_role and include_role for private sivel/ansible
4 participants
@alikins @sivel @wenottingham @ansibot