[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 3186a944e9)

Co-authored-by: Felix Fontein <felix@fontein.de>

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:

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:

plugins/modules/github_issue.py

@@ -15,6 +15,13 @@ module: github_issue
 short_description: View GitHub issue
 description:
   - 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:

plugins/modules/github_key.py

@@ -14,6 +14,13 @@ module: github_key
 short_description: Manage GitHub access keys
 description:
   - 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:

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:

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)
 '''

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:

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:

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:

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:

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'''

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).
 '''
 
 

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:

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:

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'''

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:

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:

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:

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: