Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typesetting of "GitLab" #61702

Merged
merged 1 commit into from Sep 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions lib/ansible/modules/source_control/gitlab_deploy_key.py
Expand Up @@ -31,7 +31,7 @@
options:
api_token:
description:
- Gitlab token for logging in.
- GitLab token for logging in.
version_added: "2.8"
type: str
aliases:
Expand Down Expand Up @@ -109,7 +109,7 @@
type: dict

error:
description: the error message returned by the Gitlab API
description: the error message returned by the GitLab API
returned: failed
type: str
sample: "400: key is already in use"
Expand Down Expand Up @@ -292,10 +292,10 @@ def main():
private_token=gitlab_token, api_version=4)
gitlab_instance.auth()
except (gitlab.exceptions.GitlabAuthenticationError, gitlab.exceptions.GitlabGetError) as e:
module.fail_json(msg="Failed to connect to Gitlab server: %s" % to_native(e))
module.fail_json(msg="Failed to connect to GitLab server: %s" % to_native(e))
except (gitlab.exceptions.GitlabHttpError) as e:
module.fail_json(msg="Failed to connect to Gitlab server: %s. \
Gitlab remove Session API now that private tokens are removed from user API endpoints since version 10.2." % to_native(e))
module.fail_json(msg="Failed to connect to GitLab server: %s. \
GitLab remove Session API now that private tokens are removed from user API endpoints since version 10.2." % to_native(e))

gitlab_deploy_key = GitLabDeployKey(module, gitlab_instance)

Expand Down
28 changes: 14 additions & 14 deletions lib/ansible/modules/source_control/gitlab_group.py
Expand Up @@ -15,9 +15,9 @@
DOCUMENTATION = '''
---
module: gitlab_group
short_description: Creates/updates/deletes Gitlab Groups
short_description: Creates/updates/deletes GitLab Groups
description:
- When the group does not exist in Gitlab, it will be created.
- When the group does not exist in GitLab, it will be created.
- When the group does exist and state=absent, the group will be deleted.
version_added: "2.1"
author:
Expand All @@ -31,20 +31,20 @@
options:
server_url:
description:
- The URL of the Gitlab server, with protocol (i.e. http or https).
- The URL of the GitLab server, with protocol (i.e. http or https).
required: true
type: str
login_user:
description:
- Gitlab user name.
- GitLab user name.
type: str
login_password:
description:
- Gitlab password for login_user
- GitLab password for login_user
type: str
api_token:
description:
- Gitlab token for logging in.
- GitLab token for logging in.
type: str
aliases:
- login_token
Expand Down Expand Up @@ -86,15 +86,15 @@
'''

EXAMPLES = '''
- name: "Delete Gitlab Group"
- name: "Delete GitLab Group"
gitlab_group:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
validate_certs: False
name: my_first_group
state: absent

- name: "Create Gitlab Group"
- name: "Create GitLab Group"
gitlab_group:
api_url: https://gitlab.example.com/
validate_certs: True
Expand All @@ -105,7 +105,7 @@
state: present

# The group will by created at https://gitlab.dj-wasabi.local/super_parent/parent/my_first_group
- name: "Create Gitlab SubGroup"
- name: "Create GitLab SubGroup"
gitlab_group:
api_url: https://gitlab.example.com/
validate_certs: True
Expand All @@ -130,7 +130,7 @@
type: dict

error:
description: the error message returned by the Gitlab API
description: the error message returned by the GitLab API
returned: failed
type: str
sample: "400: path is already in use"
Expand Down Expand Up @@ -340,10 +340,10 @@ def main():
private_token=gitlab_token, api_version=4)
gitlab_instance.auth()
except (gitlab.exceptions.GitlabAuthenticationError, gitlab.exceptions.GitlabGetError) as e:
module.fail_json(msg="Failed to connect to Gitlab server: %s" % to_native(e))
module.fail_json(msg="Failed to connect to GitLab server: %s" % to_native(e))
except (gitlab.exceptions.GitlabHttpError) as e:
module.fail_json(msg="Failed to connect to Gitlab server: %s. \
Gitlab remove Session API now that private tokens are removed from user API endpoints since version 10.2" % to_native(e))
module.fail_json(msg="Failed to connect to GitLab server: %s. \
GitLab remove Session API now that private tokens are removed from user API endpoints since version 10.2" % to_native(e))

# Define default group_path based on group_name
if group_path is None:
Expand All @@ -355,7 +355,7 @@ def main():
if parent_identifier:
parent_group = findGroup(gitlab_instance, parent_identifier)
if not parent_group:
module.fail_json(msg="Failed create Gitlab group: Parent group doesn't exists")
module.fail_json(msg="Failed create GitLab group: Parent group doesn't exists")

group_exists = gitlab_group.existsGroup(parent_group.full_path + '/' + group_path)
else:
Expand Down
12 changes: 6 additions & 6 deletions lib/ansible/modules/source_control/gitlab_hook.py
Expand Up @@ -32,7 +32,7 @@
options:
api_token:
description:
- Gitlab token for logging in.
- GitLab token for logging in.
version_added: "2.8"
type: str
aliases:
Expand Down Expand Up @@ -105,7 +105,7 @@
description:
- Secret token to validate hook messages at the receiver.
- If this is present it will always result in a change as it cannot be retrieved from GitLab.
- Will show up in the X-Gitlab-Token HTTP request header
- Will show up in the X-GitLab-Token HTTP request header
required: false
type: str
'''
Expand Down Expand Up @@ -153,7 +153,7 @@
type: dict

error:
description: the error message returned by the Gitlab API
description: the error message returned by the GitLab API
returned: failed
type: str
sample: "400: path is already in use"
Expand Down Expand Up @@ -365,10 +365,10 @@ def main():
private_token=gitlab_token, api_version=4)
gitlab_instance.auth()
except (gitlab.exceptions.GitlabAuthenticationError, gitlab.exceptions.GitlabGetError) as e:
module.fail_json(msg="Failed to connect to Gitlab server: %s" % to_native(e))
module.fail_json(msg="Failed to connect to GitLab server: %s" % to_native(e))
except (gitlab.exceptions.GitlabHttpError) as e:
module.fail_json(msg="Failed to connect to Gitlab server: %s. \
Gitlab remove Session API now that private tokens are removed from user API endpoints since version 10.2." % to_native(e))
module.fail_json(msg="Failed to connect to GitLab server: %s. \
GitLab remove Session API now that private tokens are removed from user API endpoints since version 10.2." % to_native(e))

gitlab_hook = GitLabHook(module, gitlab_instance)

Expand Down
26 changes: 13 additions & 13 deletions lib/ansible/modules/source_control/gitlab_project.py
Expand Up @@ -15,9 +15,9 @@
DOCUMENTATION = '''
---
module: gitlab_project
short_description: Creates/updates/deletes Gitlab Projects
short_description: Creates/updates/deletes GitLab Projects
description:
- When the project does not exist in Gitlab, it will be created.
- When the project does not exist in GitLab, it will be created.
- When the project does exists and state=absent, the project will be deleted.
- When changes are made to the project, the project will be updated.
version_added: "2.1"
Expand All @@ -32,20 +32,20 @@
options:
server_url:
description:
- The URL of the Gitlab server, with protocol (i.e. http or https).
- The URL of the GitLab server, with protocol (i.e. http or https).
required: true
type: str
login_user:
description:
- Gitlab user name.
- GitLab user name.
type: str
login_password:
description:
- Gitlab password for login_user
- GitLab password for login_user
type: str
api_token:
description:
- Gitlab token for logging in.
- GitLab token for logging in.
type: str
aliases:
- login_token
Expand Down Expand Up @@ -104,7 +104,7 @@
import_url:
description:
- Git repository which will be imported into gitlab.
- Gitlab server needs read access to this git repository.
- GitLab server needs read access to this git repository.
required: false
type: str
state:
Expand All @@ -117,7 +117,7 @@
'''

EXAMPLES = '''
- name: Delete Gitlab Project
- name: Delete GitLab Project
gitlab_project:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
Expand All @@ -126,7 +126,7 @@
state: absent
delegate_to: localhost

- name: Create Gitlab Project in group Ansible
- name: Create GitLab Project in group Ansible
gitlab_project:
api_url: https://gitlab.example.com/
validate_certs: True
Expand Down Expand Up @@ -155,7 +155,7 @@
type: dict

error:
description: the error message returned by the Gitlab API
description: the error message returned by the GitLab API
returned: failed
type: str
sample: "400: path is already in use"
Expand Down Expand Up @@ -369,10 +369,10 @@ def main():
private_token=gitlab_token, api_version=4)
gitlab_instance.auth()
except (gitlab.exceptions.GitlabAuthenticationError, gitlab.exceptions.GitlabGetError) as e:
module.fail_json(msg="Failed to connect to Gitlab server: %s" % to_native(e))
module.fail_json(msg="Failed to connect to GitLab server: %s" % to_native(e))
except (gitlab.exceptions.GitlabHttpError) as e:
module.fail_json(msg="Failed to connect to Gitlab server: %s. \
Gitlab remove Session API now that private tokens are removed from user API endpoints since version 10.2." % to_native(e))
module.fail_json(msg="Failed to connect to GitLab server: %s. \
GitLab remove Session API now that private tokens are removed from user API endpoints since version 10.2." % to_native(e))

# Set project_path to project_name if it is empty.
if project_path is None:
Expand Down
4 changes: 2 additions & 2 deletions lib/ansible/modules/source_control/gitlab_project_variable.py
Expand Up @@ -240,8 +240,8 @@ def main():
except (gitlab.exceptions.GitlabAuthenticationError, gitlab.exceptions.GitlabGetError) as e:
module.fail_json(msg="Failed to connect to GitLab server: %s" % to_native(e))
except (gitlab.exceptions.GitlabHttpError) as e:
module.fail_json(msg="Failed to connect to Gitlab server: %s. \
Gitlab remove Session API now that private tokens are removed from user API endpoints since version 10.2" % to_native(e))
module.fail_json(msg="Failed to connect to GitLab server: %s. \
GitLab remove Session API now that private tokens are removed from user API endpoints since version 10.2" % to_native(e))

this_gitlab = GitlabProjectVariables(module=module, gitlab_instance=gitlab_instance)

Expand Down
10 changes: 5 additions & 5 deletions lib/ansible/modules/source_control/gitlab_runner.py
Expand Up @@ -40,7 +40,7 @@
options:
url:
description:
- The URL of the Gitlab server, with protocol (i.e. http or https).
- The URL of the GitLab server, with protocol (i.e. http or https).
required: true
type: str
api_token:
Expand Down Expand Up @@ -141,7 +141,7 @@
type: dict

error:
description: the error message returned by the Gitlab API
description: the error message returned by the GitLab API
returned: failed
type: str
sample: "400: path is already in use"
Expand Down Expand Up @@ -354,10 +354,10 @@ def main():
private_token=gitlab_token, api_version=4)
gitlab_instance.auth()
except (gitlab.exceptions.GitlabAuthenticationError, gitlab.exceptions.GitlabGetError) as e:
module.fail_json(msg="Failed to connect to Gitlab server: %s" % to_native(e))
module.fail_json(msg="Failed to connect to GitLab server: %s" % to_native(e))
except (gitlab.exceptions.GitlabHttpError) as e:
module.fail_json(msg="Failed to connect to Gitlab server: %s. \
Gitlab remove Session API now that private tokens are removed from user API endpoints since version 10.2" % to_native(e))
module.fail_json(msg="Failed to connect to GitLab server: %s. \
GitLab remove Session API now that private tokens are removed from user API endpoints since version 10.2" % to_native(e))

gitlab_runner = GitLabRunner(module, gitlab_instance)
runner_exists = gitlab_runner.existsRunner(runner_description)
Expand Down