foodkit/jira-release-notes

A release note generator package for Laravel.

Maintainers

Details

github.com/foodkit/automated-release-notes

Source

Issues

Installs: 14

Dependents: 0

Suggesters: 0

Security: 0

Stars: 6

Watchers: 5

Forks: 5

Open Issues: 0

1.0.10 2018-06-01 04:32 UTC

Requires

Requires (Dev)

MIT 177320ba0d00bee6b6b5d538fabd140124403b95

  • Mohammad Emran Hasan <phpfour.woop@gmail.com>
  • Corey Mcmahon <contact.woop@coreymcmahon.com>

This package is not auto-updated.

Last update: 2024-11-15 19:45:17 UTC

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