https://github.com/guidesmiths/release-clerk

A command line utility for posting release notes as issues to a github shared repository
https://github.com/guidesmiths/release-clerk

Last synced: about 1 month ago
JSON representation

A command line utility for posting release notes as issues to a github shared repository

• Host: GitHub
• URL: https://github.com/guidesmiths/release-clerk
• Owner: guidesmiths
• Created: 2016-05-29T12:42:17.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-27T15:19:12.000Z (about 1 year ago)
• Last Synced: 2024-12-18T09:45:25.661Z (about 1 month ago)
• Language: JavaScript
• Size: 31.3 KB
• Stars: 0
• Watchers: 12
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Release Clerk

A command line utility for posting release notes as issues to a github shared repository. This is especially useful in a continuous deployment / micro-service environment, where developers release at will, making it difficult to keep track of what changes have been rolled out to, or back from, production.

[![Build Status](https://travis-ci.org/guidesmiths/release-clerk.png)](https://travis-ci.org/guidesmiths/release-clerk)

## Usage

```bash

npm i release-clerk

node_modules/.bin/release-clerk --help

Usage: release-clerk [options]

  Options:

     h, --help                          output usage information

    -V, --version                       output the version number

    -c --config [string]                path to config file

    -r --repository [string]            repository of the project being released

    -u --user [string]                  user/organisation of the project being released

    -p --previous-release-sha [string]  last commit sha of the previous release (if any)

    -q --current-release-sha [string]   last commit sha sha this release

    -t --title [string]                 issue title

    -s --summary [string]               issue summary

    -l --labels [string]                issue labels (comma separated string)

    -m --milestone [string]             issue milestone

    -d --debug                          debug (outputs issue to console instead of creating it)

```

## Configuration

Release Clerk will attempt to load configuration from config.json and config.js in the current working directory. You can specify this path using the ```--config``` command line argument. At a minimum you need to provide

2. An api token to authenticate the github client. See https://help.github.com/articles/creating-an-access-token-for-command-line-use

1. A user-agent for the github client. This should be user github username.

3. The user and repository you want to post release notes to.

Minimum configuration in config.js

```js

module.exports = {

    github: {

        token: "your github api token"

        headers: {

            'user-agent': 'your github username'

        }

    },

    issues: {

        user: 'organisation or github username',

        repository: 'repository where releases will be recorded'

    }

}

```

### Full Configuration

```js

module.exports = {

    github: {

        version: "3.0.0",

        debug: false,

        host: "api.github.com",

        timeout: 25000,

        pageSize: 25,

        token: "your github api token"

        headers: {

            'user-agent': 'your github username'

        }

    },

    issues: {

        user: 'organisation or github username',

        repository: 'repository where releases will be recorded',

        labels: ['LABEL 1', 'LABEL 2'],

        templates: '/path/to/custom/templates'

    }

}