Improve docs for Cloud Build (#197)

/cc @rileykarson
modular-magician · Mar 1, 2019 · 8e5608f · 8e5608f
1 parent 2c4cf3e
commit 8e5608f
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 12 deletions.
diff --git a/lib/ansible/modules/cloud/google/gcp_cloudbuild_trigger.py b/lib/ansible/modules/cloud/google/gcp_cloudbuild_trigger.py
@@ -67,6 +67,7 @@
   filename:
     description:
     - 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
   ignored_files:
     description:
@@ -114,19 +115,23 @@
         required: false
       branch_name:
         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
       tag_name:
         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
       commit_sha:
         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
   build:
     description:
-    - Contents of the build template.
+    - Contents of the build template. Either a filename or build template must be
+      provided.
     required: false
     suboptions:
       tags:
@@ -233,6 +238,7 @@
 filename:
   description:
   - 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
   type: str
 ignoredFiles:
@@ -285,22 +291,25 @@
       type: str
     branchName:
       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
       type: str
     tagName:
       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
       type: str
     commitSha:
       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
       type: str
 build:
   description:
-  - Contents of the build template.
+  - Contents of the build template. Either a filename or build template must be provided.
   returned: success
   type: complex
   contains:

diff --git a/lib/ansible/modules/cloud/google/gcp_cloudbuild_trigger_facts.py b/lib/ansible/modules/cloud/google/gcp_cloudbuild_trigger_facts.py
@@ -87,6 +87,7 @@
     filename:
       description:
       - 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
       type: str
     ignoredFiles:
@@ -142,22 +143,26 @@
           type: str
         branchName:
           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
           type: str
         tagName:
           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
           type: str
         commitSha:
           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
           type: str
     build:
       description:
-      - Contents of the build template.
+      - Contents of the build template. Either a filename or build template must be
+        provided.
       returned: success
       type: complex
       contains: