2017 © Pedro Peláez
 

library release-notes

A script for building release notes for a github-based project.

image

guywithnose/release-notes

A script for building release notes for a github-based project.

  • Thursday, May 26, 2016
  • by guywithnose
  • Repository
  • 2 Watchers
  • 2 Stars
  • 22 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 4 Forks
  • 16 Open issues
  • 11 Versions
  • 0 % Grown

The README.md

Release Notes builder tool

Look at the commits on a github repo and generate release notes using the commits that have occurred since the last tag., (*1)

Basic Usage

Release Notes requires that you specify the organization or username and the repository name. It will then process commits to build release notes and a tag on the specificed respository. You will be prompted several options to change the output and determine how the tag will be generated., (*2)

$ bin/buildRelease organization-name repo-name

There are many command line argument options that can specified to allow for the tool to run with little to no interaction from the user. All options can be viewed by running the command with --help, (*3)

$ bin/buildRelease --help

Github Integration

Github integration is done using a personal access token. This token will be requested when you run the tool the first time or you can provide the information on the command-line using --access-token argument option., (*4)

If you provide your token at the prompt of the tool it will store this token in a .access_token file. You can specify a different access token file with the --token-file argument option. The default location of this file can be changed with the --cache-dir argument option., (*5)

If you wish to use the tool with a differnt API version or a private GitHub Enterprise server then you can use --github-api argument option to change the base URL the tool uses for making API calls., (*6)

Jira Integration

Jira integration currently requires that you create a .env file that contains the server url, username, and password that you are accessing jira as., (*7)

Start by copying .env.dist to .env and modifying with your information., (*8)

Using the --jira-types and --jira-lookup argument options will attempt to find Jira issue numbers within the commit messages use for generating the notes and then query the server., (*9)

The Versions

26/05 2016

dev-master

9999999-dev

A script for building release notes for a github-based project.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Spencer Rinehart
by Anthony Bittle

github release

25/05 2016

dev-php7

dev-php7

A script for building release notes for a github-based project.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Spencer Rinehart
by Anthony Bittle

github release

25/05 2016

v1.0.0

1.0.0.0

A script for building release notes for a github-based project.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Spencer Rinehart
by Anthony Bittle

github release

25/05 2016

v0.3.1

0.3.1.0

A script for building release notes for a github-based project.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Spencer Rinehart
by Anthony Bittle

github release

25/05 2016

dev-addCaFile

dev-addCaFile

A script for building release notes for a github-based project.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Spencer Rinehart
by Anthony Bittle

github release

24/08 2015

v0.3.0

0.3.0.0

A script for building release notes for a github-based project.

  Sources   Download

MIT

The Requires

 

by Spencer Rinehart
by Anthony Bittle

github release

22/07 2015

v0.2.3

0.2.3.0

A script for building release notes for a github-based project.

  Sources   Download

MIT

The Requires

 

by Spencer Rinehart
by Anthony Bittle

github release

04/06 2014

v0.2.2

0.2.2.0

A script for building release notes for a github-based project.

  Sources   Download

MIT

The Requires

 

by Spencer Rinehart
by Anthony Bittle

github release

30/05 2014

v0.2.1

0.2.1.0

A script for building release notes for a github-based project.

  Sources   Download

MIT

The Requires

 

by Spencer Rinehart
by Anthony Bittle

github release

27/05 2014

v0.2.0

0.2.0.0

A script for building release notes for a github-based project.

  Sources   Download

MIT

The Requires

 

by Spencer Rinehart
by Anthony Bittle

github release

08/05 2014

v0.1.0

0.1.0.0

A script for building release notes for a github-based project.

  Sources   Download

MIT

The Requires

 

by Spencer Rinehart
by Anthony Bittle

github release