ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-18 16:31:26 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

[PR #6672/2ed82e03 backport][stable-7] Use semantic markup (modules d-g) (#6702)

Browse source 
Use semantic markup (modules d-g) (#6672)

* Use semantic markup.

* 'ignore:' is no longer needed.

* E() now works better.

(cherry picked from commit 2ed82e0318)

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2023-06-15 19:04:16 +02:00 • committed by GitHub
parent ecf6f585ee
commit 92466e0dbd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
34 changed files with 307 additions and 306 deletions
Download patch file Download diff file Expand all files Collapse all files

20
plugins/modules/gitlab_project_variable.py
View file

@ -14,7 +14,7 @@ description:
- When a project variable does not exist, it will be created.
- When a project variable does exist, its value will be updated when the values are different.
- Variables which are untouched in the playbook, but are not untouched in the GitLab project,
they stay untouched (I(purge) is C(false)) or will be deleted (I(purge) is C(true)).
they stay untouched (O(purge=false)) or will be deleted (O(purge=true)).
author:
- "Markus Bergholz (@markuman)"
requirements:
@ -52,15 +52,15 @@ options:
vars:
description:
- When the list element is a simple key-value pair, masked and protected will be set to false.
- When the list element is a dict with the keys I(value), I(masked) and I(protected), the user can
- When the list element is a dict with the keys C(value), C(masked) and C(protected), the user can
have full control about whether a value should be masked, protected or both.
- Support for protected values requires GitLab >= 9.3.
- Support for masked values requires GitLab >= 11.10.
- Support for environment_scope requires GitLab Premium >= 13.11.
- Support for variable_type requires GitLab >= 11.11.
- A I(value) must be a string or a number.
- Field I(variable_type) must be a string with either C(env_var), which is the default, or C(file).
- Field I(environment_scope) must be a string defined by scope environment.
- A C(value) must be a string or a number.
- Field C(variable_type) must be a string with either V(env_var), which is the default, or V(file).
- Field C(environment_scope) must be a string defined by scope environment.
- When a value is masked, it must be in Base64 and have a length of at least 8 characters.
See GitLab documentation on acceptable values for a masked variable (https://docs.gitlab.com/ce/ci/variables/#masked-variables).
default: {}
@ -69,7 +69,7 @@ options:
version_added: 4.4.0
description:
- A list of dictionaries that represents CI/CD variables.
- This module works internal with this structure, even if the older I(vars) parameter is used.
- This module works internal with this structure, even if the older O(vars) parameter is used.
default: []
type: list
elements: dict
@ -82,7 +82,7 @@ options:
value:
description:
- The variable value.
- Required when I(state=present).
- Required when O(state=present).
type: str
masked:
description:
@ -98,15 +98,15 @@ options:
default: false
variable_type:
description:
- Wether a variable is an environment variable (C(env_var)) or a file (C(file)).
- Support for I(variable_type) requires GitLab >= 11.11.
- Wether a variable is an environment variable (V(env_var)) or a file (V(file)).
- Support for O(variables[].variable_type) requires GitLab >= 11.11.
type: str
choices: ["env_var", "file"]
default: env_var
environment_scope:
description:
- The scope for the variable.
- Support for I(environment_scope) requires GitLab Premium >= 13.11.
- Support for O(variables[].environment_scope) requires GitLab Premium >= 13.11.
type: str
default: '*'
'''