2017 © Pedro Peláez
 

library automated-release-notes

A release note generator package for Laravel.

image

foodkit/automated-release-notes

A release note generator package for Laravel.

  • Friday, June 1, 2018
  • by coreymcmahon
  • Repository
  • 3 Watchers
  • 0 Stars
  • 727 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 2 Forks
  • 0 Open issues
  • 12 Versions
  • 25 % Grown

The README.md

Release Note Generator

This is a command line tool that generates markdown formatted release notes between two branches/tags., (*1)

Installation

Install the package globally via composer:, (*2)

``` sh composer global require foodkit/automated-release-notes, (*3)


## Configuration

The following configuration parameters can be passed as argument:

* `--host` issue tracker host (https://project.atlassian.net)
* `--user` issue tracker username
* `--pass` issue tracker password
* `--regex` issue prefix regular expression
* `--format` output format, can be either 'github' or 'slack'

Or, they can be placed in `.env` file within a project:

JIRA_USERNAME=user JIRA_PASSWORD=secret JIRA_URL=https://ginjath.atlassian.net JIRA_ISSUE_REGEX=/GT-[\d]+/ GIT_CUSTOM_HOSTS=github.local:github,bitbucket.local:bitbucket, (*4)


The user credential parameters can be omitted if your Jira issue api is public.

## Usage

This command will generate the release notes between two tags.

``` sh
release-notes generate --start=v2.7.8 --end=v2.8.0

This will generate the release notes between two branches., (*5)

sh release-notes generate --start=develop --end=master, (*6)

The Versions

01/06 2018

dev-master

9999999-dev

A release note generator package for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Mohammad Emran Hasan
by Corey Mcmahon

01/06 2018

1.0.10

1.0.10.0

A release note generator package for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Mohammad Emran Hasan
by Corey Mcmahon

03/01 2018

1.0.9

1.0.9.0

A release note generator package for Laravel.

  Sources   Download

MIT

The Requires

 

by Mohammad Emran Hasan
by Corey Mcmahon

06/09 2017

1.0.8

1.0.8.0

A release note generator package for Laravel.

  Sources   Download

MIT

The Requires

 

by Mohammad Emran Hasan
by Corey Mcmahon

06/09 2017

1.0.7

1.0.7.0

A release note generator package for Laravel.

  Sources   Download

MIT

The Requires

 

by Mohammad Emran Hasan
by Corey Mcmahon

06/09 2017

1.0.6

1.0.6.0

A release note generator package for Laravel.

  Sources   Download

MIT

The Requires

 

by Mohammad Emran Hasan
by Corey Mcmahon

06/09 2017

1.0.5

1.0.5.0

A release note generator package for Laravel.

  Sources   Download

MIT

The Requires

 

by Mohammad Emran Hasan
by Corey Mcmahon

06/09 2017

1.0.4

1.0.4.0

A release note generator package for Laravel.

  Sources   Download

MIT

The Requires

 

by Mohammad Emran Hasan
by Corey Mcmahon

30/08 2017

1.0.3

1.0.3.0

A release note generator package for Laravel.

  Sources   Download

MIT

The Requires

 

by Mohammad Emran Hasan
by Corey Mcmahon

15/08 2017

1.0.2

1.0.2.0

A release note generator package for Laravel.

  Sources   Download

MIT

The Requires

 

by Mohammad Emran Hasan
by Corey Mcmahon

14/08 2017

1.0.1

1.0.1.0

A release note generator package for Laravel.

  Sources   Download

MIT

The Requires

 

by Mohammad Emran Hasan
by Corey Mcmahon

23/07 2017

1.0.0

1.0.0.0

A release note generator package for Laravel.

  Sources   Download

MIT

The Requires

 

by Mohammad Emran Hasan
by Corey Mcmahon