feat: add commit status script (#27)

* feat: add commit status script

* pass description

* default label

Author: bahmutov

README.md

@@ -101,6 +101,16 @@ steps:
   - run: DEBUG=cypress:cli $(npm bin)/run-if $(npm bin)/cypress verify
 ```
 
+### Set GitHub commit status
+
+Very useful to notify other projects asynchronously via GitHub commit states.
+
+```text
+$(npm bin)/set-status --label "context label" --state success --description "short message"
+```
+
+State can be "error", "pending", "failure" or "success". `--label` is optional, if not set, then the platform and the package name will be used.
+
 ## API
 
 ### getJsonFromGit

bin/set-commit-status.js

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+
+'use strict'
+
+const debug = require('debug')('commit-message-install')
+const os = require('os')
+const path = require('path')
+
+const allArgs = process.argv.slice(2)
+const args = require('minimist')(allArgs, {
+  alias: {
+    file: 'f',
+    sha: 'commit',
+    description: 'd'
+  },
+  string: ['file', 'sha', 'state', 'label', 'description']
+})
+
+const api = require('..')
+const getMessage = api.getMessage
+const getJsonBlock = api.getJsonBlock
+const setCommitStatus = api.setCommitStatus
+
+function onError (e) {
+  console.error(e)
+  process.exit(1)
+}
+
+let start
+if (args.file) {
+  console.log('loading message from file', args.file)
+  const fs = require('fs')
+  const message = fs.readFileSync(args.file, 'utf8')
+  start = Promise.resolve(message)
+} else {
+  start = getMessage(args.sha)
+}
+start
+  .then(getJsonBlock)
+  .then(json => {
+    if (!json) {
+      debug('could not find JSON block in the Git message')
+      return
+    }
+
+    const status = json.status
+    if (!status) {
+      debug('could not find status object in the block %o', json)
+      return
+    }
+
+    if (!args.label) {
+      const name = require(path.join(process.cwd(), 'package.json')).name
+      args.label = `${os.platform()}-${os.arch()} ${name}`
+    }
+
+    return setCommitStatus(args.label, args.state, args.description, status)
+  })
+  .catch(onError)