Improve docs for Cloud Build (#197)

<!-- This change is generated by MagicModules. -->
/cc @rileykarson
This commit is contained in:
The Magician 2019-02-28 16:05:50 -08:00 committed by Alex Stephen
parent ebd14d6e56
commit 9a7c4cfc8c
2 changed files with 26 additions and 12 deletions

View file

@ -67,6 +67,7 @@ options:
filename: filename:
description: description:
- Path, from the source root, to a file whose contents is used for the template. - Path, from the source root, to a file whose contents is used for the template.
Either a filename or build template must be provided.
required: false required: false
ignored_files: ignored_files:
description: description:
@ -114,19 +115,23 @@ options:
required: false required: false
branch_name: branch_name:
description: description:
- Name of the branch to build. - Name of the branch to build. Exactly one a of branch name, tag, or commit
SHA must be provided.
required: false required: false
tag_name: tag_name:
description: description:
- Name of the tag to build. - Name of the tag to build. Exactly one of a branch name, tag, or commit SHA
must be provided.
required: false required: false
commit_sha: commit_sha:
description: description:
- Explicit commit SHA to build. - Explicit commit SHA to build. Exactly one of a branch name, tag, or commit
SHA must be provided.
required: false required: false
build: build:
description: description:
- Contents of the build template. - Contents of the build template. Either a filename or build template must be
provided.
required: false required: false
suboptions: suboptions:
tags: tags:
@ -233,6 +238,7 @@ substitutions:
filename: filename:
description: description:
- Path, from the source root, to a file whose contents is used for the template. - Path, from the source root, to a file whose contents is used for the template.
Either a filename or build template must be provided.
returned: success returned: success
type: str type: str
ignoredFiles: ignoredFiles:
@ -285,22 +291,25 @@ triggerTemplate:
type: str type: str
branchName: branchName:
description: description:
- Name of the branch to build. - Name of the branch to build. Exactly one a of branch name, tag, or commit
SHA must be provided.
returned: success returned: success
type: str type: str
tagName: tagName:
description: description:
- Name of the tag to build. - Name of the tag to build. Exactly one of a branch name, tag, or commit SHA
must be provided.
returned: success returned: success
type: str type: str
commitSha: commitSha:
description: description:
- Explicit commit SHA to build. - Explicit commit SHA to build. Exactly one of a branch name, tag, or commit
SHA must be provided.
returned: success returned: success
type: str type: str
build: build:
description: description:
- Contents of the build template. - Contents of the build template. Either a filename or build template must be provided.
returned: success returned: success
type: complex type: complex
contains: contains:

View file

@ -87,6 +87,7 @@ items:
filename: filename:
description: description:
- Path, from the source root, to a file whose contents is used for the template. - Path, from the source root, to a file whose contents is used for the template.
Either a filename or build template must be provided.
returned: success returned: success
type: str type: str
ignoredFiles: ignoredFiles:
@ -142,22 +143,26 @@ items:
type: str type: str
branchName: branchName:
description: description:
- Name of the branch to build. - Name of the branch to build. Exactly one a of branch name, tag, or commit
SHA must be provided.
returned: success returned: success
type: str type: str
tagName: tagName:
description: description:
- Name of the tag to build. - Name of the tag to build. Exactly one of a branch name, tag, or commit
SHA must be provided.
returned: success returned: success
type: str type: str
commitSha: commitSha:
description: description:
- Explicit commit SHA to build. - Explicit commit SHA to build. Exactly one of a branch name, tag, or commit
SHA must be provided.
returned: success returned: success
type: str type: str
build: build:
description: description:
- Contents of the build template. - Contents of the build template. Either a filename or build template must be
provided.
returned: success returned: success
type: complex type: complex
contains: contains: