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

Fix Ansible documentation in part of example formatting. Part 2 (#333)

Browse source 
* Fix Ansible documentation in part of example formatting

* fix

* Revert osx_defaults.py
This commit is contained in:
Andrew Klychkov 2020-05-15 13:27:06 +03:00 • committed by GitHub
parent 328319b926
commit 327832dcbb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 299 additions and 268 deletions
Download patch file Download diff file Expand all files Collapse all files

24
plugins/modules/source_control/github/github_deploy_key.py
View file

@ -75,8 +75,8 @@ notes:
'''
EXAMPLES = '''
# add a new read-only deploy key to a GitHub repository using basic authentication
- github_deploy_key:
- name: Add a new read-only deploy key to a GitHub repository using basic authentication
github_deploy_key:
owner: "johndoe"
repo: "example"
name: "new-deploy-key"
@ -85,8 +85,8 @@ EXAMPLES = '''
username: "johndoe"
password: "supersecretpassword"
# remove an existing deploy key from a GitHub repository
- github_deploy_key:
- name: Remove an existing deploy key from a GitHub repository
github_deploy_key:
owner: "johndoe"
repository: "example"
name: "new-deploy-key"
@ -96,8 +96,8 @@ EXAMPLES = '''
password: "supersecretpassword"
state: absent
# add a new deploy key to a GitHub repository, replace an existing key, use an OAuth2 token to authenticate
- github_deploy_key:
- name: Add a new deploy key to a GitHub repository, replace an existing key, use an OAuth2 token to authenticate
github_deploy_key:
owner: "johndoe"
repository: "example"
name: "new-deploy-key"
@ -105,8 +105,8 @@ EXAMPLES = '''
force: yes
token: "ABAQDAwXxn7kIMNWzcDfo..."
# re-add a deploy key to a GitHub repository but with a different name
- github_deploy_key:
- name: Re-add a deploy key to a GitHub repository but with a different name
github_deploy_key:
owner: "johndoe"
repository: "example"
name: "replace-deploy-key"
@ -114,8 +114,8 @@ EXAMPLES = '''
username: "johndoe"
password: "supersecretpassword"
# add a new deploy key to a GitHub repository using 2FA
- github_deploy_key:
- name: Add a new deploy key to a GitHub repository using 2FA
github_deploy_key:
owner: "johndoe"
repo: "example"
name: "new-deploy-key-2"
@ -124,8 +124,8 @@ EXAMPLES = '''
password: "supersecretpassword"
otp: 123456
# add a read-only deploy key to a repository hosted on GitHub Enterprise
- github_deploy_key:
- name: Add a read-only deploy key to a repository hosted on GitHub Enterprise
github_deploy_key:
github_url: "https://api.example.com"
owner: "janedoe"
repo: "example"

11
plugins/modules/source_control/github/github_hooks.py
View file

@ -60,17 +60,18 @@ author: "Phillip Gentry, CX Inc (@pcgentry)"
'''
EXAMPLES = '''
# Example creating a new service hook. It ignores duplicates.
- github_hooks:
- name: Create a new service hook ignoring duplicates
github_hooks:
action: create
hookurl: http://11.111.111.111:2222
user: '{{ gituser }}'
oauthkey: '{{ oauthkey }}'
repo: https://api.github.com/repos/pcgentry/Github-Auto-Deploy
# Cleaning all hooks for this repo that had an error on the last update. Since this works for all hooks in a repo it is probably best that this would
# be called from a handler.
- github_hooks:
# Cleaning all hooks for this repo that had an error on the last update.
# Since this works for all hooks in a repo it is probably best that this would be called from a handler.
- name: Clean all hooks
github_hooks:
action: cleanall
user: '{{ gituser }}'
oauthkey: '{{ oauthkey }}'