ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-19 08:51:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

[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

28
plugins/modules/github_repo.py
View file

@ -15,7 +15,7 @@ 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).
- Authentication can be done with O(access_token) or with O(username) and O(password).
extends_documentation_fragment:
- community.general.attributes
attributes:
@ -27,19 +27,19 @@ 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:
@ -50,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:
@ -73,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:
@ -84,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
@ -125,7 +125,7 @@ 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
'''