collection 교체

collection/community/general/plugins/modules/github_repo.py

@@ -1,8 +1,9 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-# Copyright: (c) 2021, Álvaro Torres Cogollo
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (c) 2021, Álvaro Torres Cogollo
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
@@ -13,25 +14,32 @@ 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 O(access_token) or with O(username) and O(password).
+extends_documentation_fragment:
+  - community.general.attributes
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   username:
     description:
     - Username used for authentication.
-    - This is only needed when not using I(access_token).
+    - This is only needed when not using O(access_token).
     type: str
     required: false
   password:
     description:
     - Password used for authentication.
-    - This is only needed when not using I(access_token).
+    - This is only needed when not using O(access_token).
     type: str
     required: false
   access_token:
     description:
     - Token parameter for authentication.
-    - This is only needed when not using I(username) and I(password).
+    - This is only needed when not using O(username) and O(password).
     type: str
     required: false
   name:
@@ -42,17 +50,17 @@ options:
   description:
     description:
     - Description for the repository.
-    - Defaults to empty if I(force_defaults=true), which is the default in this module.
-    - Defaults to empty if I(force_defaults=false) when creating a new repository.
-    - This is only used when I(state) is C(present).
+    - Defaults to empty if O(force_defaults=true), which is the default in this module.
+    - Defaults to empty if O(force_defaults=false) when creating a new repository.
+    - This is only used when O(state) is V(present).
     type: str
     required: false
   private:
     description:
     - Whether the repository should be private or not.
-    - Defaults to C(false) if I(force_defaults=true), which is the default in this module.
-    - Defaults to C(false) if I(force_defaults=false) when creating a new repository.
-    - This is only used when I(state) is C(present).
+    - Defaults to V(false) if O(force_defaults=true), which is the default in this module.
+    - Defaults to V(false) if O(force_defaults=false) when creating a new repository.
+    - This is only used when O(state=present).
     type: bool
     required: false
   state:
@@ -65,7 +73,7 @@ options:
   organization:
     description:
     - Organization for the repository.
-    - When I(state) is C(present), the repository will be created in the current user profile.
+    - When O(state=present), the repository will be created in the current user profile.
     type: str
     required: false
   api_url:
@@ -76,8 +84,8 @@ options:
     version_added: "3.5.0"
   force_defaults:
     description:
-    - Overwrite current I(description) and I(private) attributes with defaults if set to C(true), which currently is the default.
-    - The default for this option will be deprecated in a future version of this collection, and eventually change to C(false).
+    - Overwrite current O(description) and O(private) attributes with defaults if set to V(true), which currently is the default.
+    - The default for this option will be deprecated in a future version of this collection, and eventually change to V(false).
     type: bool
     default: true
     required: false
@@ -88,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)
 '''
@@ -100,9 +107,9 @@ EXAMPLES = '''
     organization: MyOrganization
     name: myrepo
     description: "Just for fun"
-    private: yes
+    private: true
     state: present
-    force_defaults: no
+    force_defaults: false
   register: result
 
 - name: Delete the repository
@@ -118,13 +125,12 @@ EXAMPLES = '''
 RETURN = '''
 repo:
   description: Repository information as JSON. See U(https://docs.github.com/en/rest/reference/repos#get-a-repository).
-  returned: success and I(state) is C(present)
+  returned: success and O(state=present)
   type: dict
 '''
 
 import traceback
 from ansible.module_utils.basic import AnsibleModule, missing_required_lib
-import sys
 
 GITHUB_IMP_ERR = None
 try: