fix: Improve reporting for failed checks (#30)

* fix: Validate PR title before setting the status.

* Don't show success message when PR title validation fails.

* Use branch.

* Log validation error.

* More logging.

* Try different event.

* Shorter error message.

* Add github release.

* Remove logging.

* Fix wording.

.eslintrc.js

@@ -0,0 +1,11 @@
+// This enables ESLint to use dependencies of this config
+// (see https://github.com/eslint/eslint/issues/3458)
+require('eslint-config-molindo/setupPlugins');
+
+module.exports = {
+  extends: 'molindo/javascript',
+  env: {
+    node: true,
+    jest: true
+  }
+};

.releaserc.json

@@ -20,6 +20,12 @@
     }],
     "@semantic-release/release-notes-generator",
     ["@semantic-release/changelog", {"changelogTitle": "# Changelog"}],
+    ["@semantic-release/github", {
+      "successComment": false,
+      "failComment": false,
+      "failTitle": false,
+      "releasedLabels": false
+    }],
     ["@semantic-release/git", {"message": "Release ${nextRelease.version}"}]
   ]
 }

README.md

@@ -4,7 +4,24 @@ This is a [Github Action](https://github.com/features/actions) that ensures that
 
 This is helpful when you're using [semantic-release](https://github.com/semantic-release/semantic-release) with the Conventional Commits preset. When using the "Squash and merge" strategy, Github will suggest to use the PR title as the commit message. With this action you can validate that the PR title will lead to a correct commit message.
 
-## Example
+## Validation
+
+Examples for valid PR titles:
+- fix: Correct typo.
+- feat: Add support for Node 12.
+- refactor!: Drop support for Node 6.
+
+Note that since PR titles only have a single line, you have to use the `!` syntax for breaking changes.
+
+See [Conventional Commits](https://www.conventionalcommits.org/) for more examples.
+
+### Work in progress
+
+Github has support for [draft pull requests](https://github.blog/2019-02-14-introducing-draft-pull-requests/), which will disable the merge button until the PR is marked as ready for merge.
+
+However, [this feature might be disabled for your repository](https://github.community/t/draft-pull-requests-not-available/1753/7). In this case you can use the special `[WIP] ` prefix to indicate that a pull request is work in progress and isn't ready to be merged. This will avoid the validation of the PR title and the pull request checks remain pending.
+
+## Example config
 
 ```yml
 name: "Lint PR"
@@ -24,15 +41,4 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-Examples for valid PR titles:
-- fix: Correct typo.
-- feat: Add support for Node 12.
-- refactor!: Drop support for Node 6.
-
-Note that since PR titles only have a single line, you have to use the `!` syntax for breaking changes.
-
-See [Conventional Commits](https://www.conventionalcommits.org/) for more examples.
-
-Additionally, the special `[WIP] ` prefix is supported, to indicate that a pull request is work in progress and isn't ready to be merged. In this case the PR title isn't validated and the pull request checks remain pending.
-
-Note the usage of [`pull_request_target`](https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/) in place of `pull_request` as the event trigger is necessary for a fork-based workflow so the API token is valid for status reporting.
+Note the usage of [`pull_request_target`](https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/) as the event trigger is necessary for a fork-based workflow so the API token is valid for status reporting.