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.

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

Describe branch naming conventions #54

Merged
merged 2 commits into from
Jan 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,10 @@ We plan to regularly release new minor or bugfix versions once new features or b

Enterprise SONiC Ansible Modules deprecation cycle is aligned with [Ansible](https://docs.ansible.com/ansible/latest/dev_guide/module_lifecycle.html).

Source control branches on Github:
- Released code versions are located on "release" branches with names of the form "M.x", where "M" specifies the "major" release version for releases residing on the branch.
- Unreleased and pre-release code versions are located on sub-branches of the "main" branch. This is a development branch, and is not intended for use in production environments.

Code of Conduct
---------------

Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/sonic_command.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
argument that causes the module to wait for a specific condition
before returning or time out if the condition is not met.
- This module does not support running commands in configuration mode.
To configure SONiC devices, use M(sonic_config).
To configure SONiC devices, use the "sonic_config" module.
options:
commands:
description:
Expand Down
23 changes: 14 additions & 9 deletions plugins/modules/sonic_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,27 @@
description:
- When supplied, this argument restricts the facts collected
to a given subset. Possible values for this argument include
all, min, hardware, config, legacy, and interfaces. Can specify a
list of values to include a larger subset. Values can also be used
with an initial C(M(!)) to specify that a specific subset should
not be collected.
all, min, hardware, config, legacy, and interfaces. It can also
specify a list of values to include a larger subset. A value
can also be enclosed in double quotes and preceded by an
exclamation mark to indicate that the corresponding
information should not be collected.
required: false
type: list
elements: str
default: '!config'
gather_network_resources:
description:
- When supplied, this argument restricts the facts collected
to a given subset. Possible values for this argument include
all and the resources like 'all', 'interfaces', 'vlans', 'lag_interfaces', 'l2_interfaces', 'l3_interfaces'.
Can specify a list of values to include a larger subset. Values
can also be used with an initial C(M(!)) to specify that a
specific subset should not be collected.
to a given network resource or a given list of network
resources. Possible values for this argument include
'all' and specific network resource names such as
'interfaces', 'vlans', 'lag_interfaces', 'l2_interfaces',
and 'l3_interfaces'. Multiple resources can be specified by
placing them in a comma-separated list. A given value
can also be enclosed in double quotes and preceded by an
exclamation mark to indicate that the information for the
corresponding resource should not be collected.
required: false
type: list
elements: str
Expand Down