1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Add attributes to git* modules (#5947)

Add attributes to git* modules.
This commit is contained in:
Felix Fontein 2023-02-20 17:26:28 +01:00 committed by GitHub
parent 1b2c2af9a8
commit 3186a944e9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
19 changed files with 140 additions and 14 deletions

View file

@ -21,10 +21,17 @@ requirements: ['git']
short_description: Read and write git configuration short_description: Read and write git configuration
description: description:
- The C(git_config) module changes git configuration by invoking 'git config'. - The C(git_config) module changes git configuration by invoking 'git config'.
This is needed if you don't want to use M(ansible.builtin.template) for the entire git This is needed if you do not want to use M(ansible.builtin.template) for the entire git
config file (e.g. because you need to change just C(user.email) in config file (for example because you need to change just C(user.email) in
/etc/.git/config). Solutions involving M(ansible.builtin.command) are cumbersome or /etc/.git/config). Solutions involving M(ansible.builtin.command) are cumbersome or
don't work correctly in check mode. do not work correctly in check mode.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
list_all: list_all:
description: description:

View file

@ -18,6 +18,13 @@ description:
- "Adds or removes deploy keys for GitHub repositories. Supports authentication using username and password, - "Adds or removes deploy keys for GitHub repositories. Supports authentication using username and password,
username and password and 2-factor authentication code (OTP), OAuth2 token, or personal access token. Admin username and password and 2-factor authentication code (OTP), OAuth2 token, or personal access token. Admin
rights on the repository are required." rights on the repository are required."
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
github_url: github_url:
description: description:

View file

@ -15,6 +15,13 @@ module: github_issue
short_description: View GitHub issue short_description: View GitHub issue
description: description:
- View GitHub issue for a given repository and organization. - View GitHub issue for a given repository and organization.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
repo: repo:
description: description:

View file

@ -14,6 +14,13 @@ module: github_key
short_description: Manage GitHub access keys short_description: Manage GitHub access keys
description: description:
- Creates, removes, or updates GitHub access keys. - Creates, removes, or updates GitHub access keys.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
token: token:
description: description:

View file

@ -15,6 +15,13 @@ module: github_release
short_description: Interact with GitHub Releases short_description: Interact with GitHub Releases
description: description:
- Fetch metadata about GitHub Releases - Fetch metadata about GitHub Releases
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
token: token:
description: description:

View file

@ -14,8 +14,15 @@ module: github_repo
short_description: Manage your repositories on Github short_description: Manage your repositories on Github
version_added: 2.2.0 version_added: 2.2.0
description: description:
- Manages Github repositories using PyGithub library. - Manages Github repositories using PyGithub library.
- Authentication can be done with I(access_token) or with I(username) and I(password). - Authentication can be done with I(access_token) or with I(username) and I(password).
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
username: username:
description: description:
@ -89,7 +96,6 @@ notes:
- For Python 3, PyGithub>=1.54 should be used. - For Python 3, PyGithub>=1.54 should be used.
- "For Python 3.5, PyGithub==1.54 should be used. More information: U(https://pygithub.readthedocs.io/en/latest/changes.html#version-1-54-november-30-2020)." - "For Python 3.5, PyGithub==1.54 should be used. More information: U(https://pygithub.readthedocs.io/en/latest/changes.html#version-1-54-november-30-2020)."
- "For Python 2.7, PyGithub==1.45 should be used. More information: U(https://pygithub.readthedocs.io/en/latest/changes.html#version-1-45-december-29-2019)." - "For Python 2.7, PyGithub==1.45 should be used. More information: U(https://pygithub.readthedocs.io/en/latest/changes.html#version-1-45-december-29-2019)."
- Supports C(check_mode).
author: author:
- Álvaro Torres Cogollo (@atorrescogollo) - Álvaro Torres Cogollo (@atorrescogollo)
''' '''

View file

@ -16,6 +16,13 @@ description:
- "Create and delete GitHub webhooks" - "Create and delete GitHub webhooks"
requirements: requirements:
- "PyGithub >= 1.3.5" - "PyGithub >= 1.3.5"
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
repository: repository:
description: description:

View file

@ -21,6 +21,13 @@ requirements:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.auth_basic - community.general.auth_basic
- community.general.gitlab - community.general.gitlab
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
state: state:

View file

@ -25,6 +25,13 @@ requirements:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.auth_basic - community.general.auth_basic
- community.general.gitlab - community.general.gitlab
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
project: project:

View file

@ -25,6 +25,13 @@ requirements:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.auth_basic - community.general.auth_basic
- community.general.gitlab - community.general.gitlab
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
name: name:

View file

@ -22,6 +22,13 @@ requirements:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.auth_basic - community.general.auth_basic
- community.general.gitlab - community.general.gitlab
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
gitlab_group: gitlab_group:
@ -81,8 +88,6 @@ options:
elements: str elements: str
choices: ['guest', 'reporter', 'developer', 'maintainer', 'owner'] choices: ['guest', 'reporter', 'developer', 'maintainer', 'owner']
version_added: 3.6.0 version_added: 3.6.0
notes:
- Supports C(check_mode).
''' '''
EXAMPLES = r''' EXAMPLES = r'''

View file

@ -26,6 +26,13 @@ requirements:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.auth_basic - community.general.auth_basic
- community.general.gitlab - community.general.gitlab
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
state: state:
@ -99,8 +106,6 @@ options:
- The scope for the variable. - The scope for the variable.
type: str type: str
default: '*' default: '*'
notes:
- Supports I(check_mode).
''' '''

View file

@ -26,6 +26,13 @@ requirements:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.auth_basic - community.general.auth_basic
- community.general.gitlab - community.general.gitlab
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
project: project:

View file

@ -26,6 +26,13 @@ requirements:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.auth_basic - community.general.auth_basic
- community.general.gitlab - community.general.gitlab
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
group: group:

View file

@ -25,6 +25,13 @@ requirements:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.auth_basic - community.general.auth_basic
- community.general.gitlab - community.general.gitlab
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
project: project:
@ -82,8 +89,6 @@ options:
elements: str elements: str
choices: ['guest', 'reporter', 'developer', 'maintainer'] choices: ['guest', 'reporter', 'developer', 'maintainer']
version_added: 3.7.0 version_added: 3.7.0
notes:
- Supports C(check_mode).
''' '''
EXAMPLES = r''' EXAMPLES = r'''

View file

@ -23,6 +23,13 @@ requirements:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.auth_basic - community.general.auth_basic
- community.general.gitlab - community.general.gitlab
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
state: state:

View file

@ -21,6 +21,13 @@ requirements:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.auth_basic - community.general.auth_basic
- community.general.gitlab - community.general.gitlab
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
state: state:

View file

@ -35,6 +35,13 @@ requirements:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.auth_basic - community.general.auth_basic
- community.general.gitlab - community.general.gitlab
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
project: project:

View file

@ -33,6 +33,13 @@ requirements:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.auth_basic - community.general.auth_basic
- community.general.gitlab - community.general.gitlab
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
name: name: