From 2f05cd3330bb844eb692e880214379dc4091a42e Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Mon, 20 Feb 2023 17:41:58 +0100 Subject: [PATCH] [PR #5947/3186a944 backport][stable-6] Add attributes to git* modules (#6018) Add attributes to git* modules (#5947) Add attributes to git* modules. (cherry picked from commit 3186a944e929358e78c9c1c0824692d6be2ee706) Co-authored-by: Felix Fontein --- plugins/modules/git_config.py | 13 ++++++++++--- plugins/modules/github_deploy_key.py | 7 +++++++ plugins/modules/github_issue.py | 9 ++++++++- plugins/modules/github_key.py | 9 ++++++++- plugins/modules/github_release.py | 7 +++++++ plugins/modules/github_repo.py | 12 +++++++++--- plugins/modules/github_webhook.py | 7 +++++++ plugins/modules/gitlab_branch.py | 7 +++++++ plugins/modules/gitlab_deploy_key.py | 7 +++++++ plugins/modules/gitlab_group.py | 7 +++++++ plugins/modules/gitlab_group_members.py | 9 +++++++-- plugins/modules/gitlab_group_variable.py | 9 +++++++-- plugins/modules/gitlab_hook.py | 7 +++++++ plugins/modules/gitlab_project.py | 7 +++++++ plugins/modules/gitlab_project_members.py | 9 +++++++-- plugins/modules/gitlab_project_variable.py | 7 +++++++ plugins/modules/gitlab_protected_branch.py | 7 +++++++ plugins/modules/gitlab_runner.py | 7 +++++++ plugins/modules/gitlab_user.py | 7 +++++++ 19 files changed, 140 insertions(+), 14 deletions(-) diff --git a/plugins/modules/git_config.py b/plugins/modules/git_config.py index 9191de0e87..d673121748 100644 --- a/plugins/modules/git_config.py +++ b/plugins/modules/git_config.py @@ -21,10 +21,17 @@ requirements: ['git'] short_description: Read and write git configuration description: - 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 - config file (e.g. because you need to change just C(user.email) in + This is needed if you do not want to use M(ansible.builtin.template) for the entire git + 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 - 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: list_all: description: diff --git a/plugins/modules/github_deploy_key.py b/plugins/modules/github_deploy_key.py index bd32438b0a..322650bf70 100644 --- a/plugins/modules/github_deploy_key.py +++ b/plugins/modules/github_deploy_key.py @@ -18,6 +18,13 @@ description: - "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 rights on the repository are required." +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: github_url: description: diff --git a/plugins/modules/github_issue.py b/plugins/modules/github_issue.py index d49837499a..4e10e9f925 100644 --- a/plugins/modules/github_issue.py +++ b/plugins/modules/github_issue.py @@ -14,7 +14,14 @@ DOCUMENTATION = ''' module: github_issue short_description: View GitHub issue 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: repo: description: diff --git a/plugins/modules/github_key.py b/plugins/modules/github_key.py index 3c7ee7bd7b..683a963a7f 100644 --- a/plugins/modules/github_key.py +++ b/plugins/modules/github_key.py @@ -13,7 +13,14 @@ DOCUMENTATION = ''' module: github_key short_description: Manage GitHub access keys 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: token: description: diff --git a/plugins/modules/github_release.py b/plugins/modules/github_release.py index 0b3a5a886c..3ddd6c8820 100644 --- a/plugins/modules/github_release.py +++ b/plugins/modules/github_release.py @@ -15,6 +15,13 @@ module: github_release short_description: Interact with GitHub Releases description: - Fetch metadata about GitHub Releases +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: token: description: diff --git a/plugins/modules/github_repo.py b/plugins/modules/github_repo.py index d01312fcfa..97076c58af 100644 --- a/plugins/modules/github_repo.py +++ b/plugins/modules/github_repo.py @@ -14,8 +14,15 @@ module: github_repo short_description: Manage your repositories on Github version_added: 2.2.0 description: -- Manages Github repositories using PyGithub library. -- Authentication can be done with I(access_token) or with I(username) and I(password). + - Manages Github repositories using PyGithub library. + - 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: username: description: @@ -89,7 +96,6 @@ notes: - 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 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: - Álvaro Torres Cogollo (@atorrescogollo) ''' diff --git a/plugins/modules/github_webhook.py b/plugins/modules/github_webhook.py index b97087d221..71e199adbe 100644 --- a/plugins/modules/github_webhook.py +++ b/plugins/modules/github_webhook.py @@ -16,6 +16,13 @@ description: - "Create and delete GitHub webhooks" requirements: - "PyGithub >= 1.3.5" +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: repository: description: diff --git a/plugins/modules/gitlab_branch.py b/plugins/modules/gitlab_branch.py index e57ca4922f..d7eecb33fb 100644 --- a/plugins/modules/gitlab_branch.py +++ b/plugins/modules/gitlab_branch.py @@ -21,6 +21,13 @@ requirements: extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab + - community.general.attributes + +attributes: + check_mode: + support: none + diff_mode: + support: none options: state: diff --git a/plugins/modules/gitlab_deploy_key.py b/plugins/modules/gitlab_deploy_key.py index f4a9fb29fa..27cb01f87e 100644 --- a/plugins/modules/gitlab_deploy_key.py +++ b/plugins/modules/gitlab_deploy_key.py @@ -25,6 +25,13 @@ requirements: extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none options: project: diff --git a/plugins/modules/gitlab_group.py b/plugins/modules/gitlab_group.py index d099a0c274..624028f298 100644 --- a/plugins/modules/gitlab_group.py +++ b/plugins/modules/gitlab_group.py @@ -25,6 +25,13 @@ requirements: extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: diff --git a/plugins/modules/gitlab_group_members.py b/plugins/modules/gitlab_group_members.py index 6edc8c983f..66298e882c 100644 --- a/plugins/modules/gitlab_group_members.py +++ b/plugins/modules/gitlab_group_members.py @@ -22,6 +22,13 @@ requirements: extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none options: gitlab_group: @@ -81,8 +88,6 @@ options: elements: str choices: ['guest', 'reporter', 'developer', 'maintainer', 'owner'] version_added: 3.6.0 -notes: - - Supports C(check_mode). ''' EXAMPLES = r''' diff --git a/plugins/modules/gitlab_group_variable.py b/plugins/modules/gitlab_group_variable.py index 4a185b2394..c7befe123c 100644 --- a/plugins/modules/gitlab_group_variable.py +++ b/plugins/modules/gitlab_group_variable.py @@ -26,6 +26,13 @@ requirements: extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none options: state: @@ -99,8 +106,6 @@ options: - The scope for the variable. type: str default: '*' -notes: -- Supports I(check_mode). ''' diff --git a/plugins/modules/gitlab_hook.py b/plugins/modules/gitlab_hook.py index 70864207ed..adf90eb7bc 100644 --- a/plugins/modules/gitlab_hook.py +++ b/plugins/modules/gitlab_hook.py @@ -26,6 +26,13 @@ requirements: extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none options: project: diff --git a/plugins/modules/gitlab_project.py b/plugins/modules/gitlab_project.py index 1ab8ae220c..cd34db4431 100644 --- a/plugins/modules/gitlab_project.py +++ b/plugins/modules/gitlab_project.py @@ -26,6 +26,13 @@ requirements: extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none options: group: diff --git a/plugins/modules/gitlab_project_members.py b/plugins/modules/gitlab_project_members.py index 84e3c9b8e1..9053584431 100644 --- a/plugins/modules/gitlab_project_members.py +++ b/plugins/modules/gitlab_project_members.py @@ -25,6 +25,13 @@ requirements: extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none options: project: @@ -82,8 +89,6 @@ options: elements: str choices: ['guest', 'reporter', 'developer', 'maintainer'] version_added: 3.7.0 -notes: - - Supports C(check_mode). ''' EXAMPLES = r''' diff --git a/plugins/modules/gitlab_project_variable.py b/plugins/modules/gitlab_project_variable.py index 5e6a2904dc..63569dd789 100644 --- a/plugins/modules/gitlab_project_variable.py +++ b/plugins/modules/gitlab_project_variable.py @@ -23,6 +23,13 @@ requirements: extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none options: state: diff --git a/plugins/modules/gitlab_protected_branch.py b/plugins/modules/gitlab_protected_branch.py index 335e1445a2..fea374cbfd 100644 --- a/plugins/modules/gitlab_protected_branch.py +++ b/plugins/modules/gitlab_protected_branch.py @@ -21,6 +21,13 @@ requirements: extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none options: state: diff --git a/plugins/modules/gitlab_runner.py b/plugins/modules/gitlab_runner.py index e0ef43a316..f0da30e8f2 100644 --- a/plugins/modules/gitlab_runner.py +++ b/plugins/modules/gitlab_runner.py @@ -35,6 +35,13 @@ requirements: extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none options: project: diff --git a/plugins/modules/gitlab_user.py b/plugins/modules/gitlab_user.py index 4824f7301f..94f3713160 100644 --- a/plugins/modules/gitlab_user.py +++ b/plugins/modules/gitlab_user.py @@ -33,6 +33,13 @@ requirements: extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: