Add info around reporting custom PR status to GitHub

[dacharyc]

A Tugboat user in the Support Slack asked about creating a custom PR status for running PHPUnit functional tests in the online phase.

@bchavet suggested this:

Catch the error & report it using a curl to GitHub’s API. An example like this should work:
curl -H "Authorization: token $GHTOKEN" -X POST -d '{"state": "failure", "context": "Custom Check"}' https://api.github.com/repos/$TUGBOAT_GITHUB_OWNER/$TUGBOAT_GITHUB_REPO/statuses/$TUGBOAT_PREVIEW_SHA

Where $GHTOKEN is an environment variable you define on the Tugboat repo with a GitHub API token.

If tests are done with a single command, this example should work:

your-command-here && \ curl -H "Authorization: token $GHTOKEN" -X POST -d '{"state": "success", "context": "Custom Check"}' \ https://api.github.com/repos/$TUGBOAT_GITHUB_OWNER/$TUGBOAT_GITHUB_REPO/statuses/$TUGBOAT_PREVIEW_SHA || \ curl -H "Authorization: token $GHTOKEN" -X POST -d '{"state": "failure", "context": "Custom Check"}' \ https://api.github.com/repos/$TUGBOAT_GITHUB_OWNER/$TUGBOAT_GITHUB_REPO/statuses/$TUGBOAT_PREVIEW_SHA

Ben pulled the info for this from these resources:

• https://docs.tugboat.qa/reference/environment-variables/
• https://docs.tugboat.qa/setting-up-services/how-to-set-up-services/custom-environment-variables/
• https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#create-a-commit-status

[longwave]

For reference this is the online phase YAML I use to get Drupal 9 PHPUnit tests running on Tugboat and reporting back to GitHub. This also includes setting the status as "pending" before the test run.

online:
  - >
    curl -s -H "Authorization: token $GHTOKEN" -X POST -d '{"state": "pending", "context": "PHPUnit"}' https://api.github.com/repos/$TUGBOAT_GITHUB_OWNER/$TUGBOAT_GITHUB_REPO/statuses/$TUGBOAT_PREVIEW_SHA
  - >
    cd ${TUGBOAT_ROOT}/web
    && SIMPLETEST_BASE_URL=${TUGBOAT_SERVICE_URL}  SIMPLETEST_DB="mysql://tugboat:tugboat@mysql/tugboat" SYMFONY_DEPRECATIONS_HELPER=disabled ../vendor/bin/phpunit
    && curl -s -H "Authorization: token $GHTOKEN" -X POST -d '{"state": "success", "context": "PHPUnit"}' https://api.github.com/repos/$TUGBOAT_GITHUB_OWNER/$TUGBOAT_GITHUB_REPO/statuses/$TUGBOAT_PREVIEW_SHA
    || curl -s -H "Authorization: token $GHTOKEN" -X POST -d '{"state": "failure", "context": "PHPUnit"}' https://api.github.com/repos/$TUGBOAT_GITHUB_OWNER/$TUGBOAT_GITHUB_REPO/statuses/$TUGBOAT_PREVIEW_SHA

[dacharyc]

Thanks, @longwave ! That's excellent. I'll incorporate that into the new doc 👍