Better docs for build:comment:add:commit and build:comment:add:pr

README.md

@@ -156,6 +156,8 @@ Additional options are available to further customize the `build:project:repair`
 
 The `build:comment:add:commit` command is used to add a comment to a commit on the Git Provider. This is useful in CI scripts for commenting as multidev environments are created or other code feedback is determined.
 
+Either the `--message` and/or the `--site_url` options are required.
+
 #### Command Options
 
 Additional options are available to customize the `build:comment:add:commit` command:
@@ -165,7 +167,23 @@ Additional options are available to customize the `build:comment:add:commit` com
  | --sha            | The SHA hash of the commit to add the comment to |
  | --message        | The message to post to the commit |
  | --site_url       | If provided, will include a "Visit Site" link at the start of the comment, linking to the provided site URL |
-
+
+### terminus build:comment:add:pr
+
+The `build:comment:add:pr` command is used to add a comment to a pull request on the Git Provider. This is useful in CI scripts for commenting as multidev environments are created or other code feedback is determined.
+
+The `--pr_id` option and either the `--message` and/or the `--site_url` options are required.
+
+#### Command Options
+
+Additional options are available to customize the `build:comment:add:pr` command:
+
+ | Option           | Description      |
+ | ---------------- | ---------------- |
+ | --pr_id          | Required. The number of the pull request to add the comment to |
+ | --message        | The message to post to the pull request |
+ | --site_url       | If provided, will include a "Visit Site" link at the start of the pull request, linking to the provided site URL |
+
 ### build:credentials:clear
 
 The `build:credentials:clear` command is available to clear cached credentials from Build Tools. This is useful when developing Build Tools or trying to remove credentials from a machine.
@@ -417,6 +435,10 @@ This command will commit the generated artifacts to an existing multidev environ
 
 `terminus build:env:list`
 
+### Commenting on a pull request or merge request
+
+`terminus build:comment:add:pr --pr_number=123 --message="Behat tests passed!"`
+
 ## Help
 Run `terminus list build` for a complete list of available commands. Use `terminus help <command>` to get help on one command.
 

src/Commands/CommentAddCommitCommand.php

@@ -9,6 +9,8 @@
 
 namespace Pantheon\TerminusBuildTools\Commands;
 
+use Pantheon\Terminus\Exceptions\TerminusException;
+
 /**
  * Commit Comment Command
  */
@@ -53,6 +55,8 @@ public function commentAddCommit(
             // Submit message
             $targetProject = $this->projectFromRemoteUrl($remoteUrlFromGit);
             $this->git_provider->commentOnCommit($targetProject, $commitHash, $message);
+        } else {
+            throw new TerminusException( '--message and/or --site_url are required.' );
         }
     }
 }

src/Commands/CommentAddPullRequestCommand.php

@@ -55,6 +55,8 @@ public function commentAddPullRequest(
             // Submit message
             $targetProject = $this->projectFromRemoteUrl($remoteUrlFromGit);
             $this->git_provider->commentOnPullRequest($targetProject, $prId, $message);
+        } else {
+            throw new TerminusException( '--message and/or --site_url are required.' );
         }
     }
 }