foodkit/automated-release-notes

A release note generator package for Laravel.

1.0.10 2018-06-01 04:32 UTC

Requires

• php: >=5.5.0
• guzzlehttp/guzzle: ~6.2
• symfony/console: 2.8.*|3.0.*|3.1.*|3.2.*|3.3.*
• vlucas/phpdotenv: ^2.4

Requires (Dev)

• phpunit/phpunit: ^6

MIT

• Mohammad Emran Hasan
• Corey Mcmahon

README

This is a command line tool that generates markdown formatted release notes between two branches/tags.

Installation

Install the package globally via composer:

composer global require foodkit/automated-release-notes

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

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.

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

This will generate the release notes between two branches.

release-notes generate --start=develop --end=master