| Package Data | |
|---|---|
| Maintainer Username: | coreymcmahon |
| Maintainer Contact: | contact@coreymcmahon.com (Corey Mcmahon) |
| Package Create Date: | 2017-07-18 |
| Package Last Update: | 2018-06-01 |
| Home Page: | |
| Language: | PHP |
| License: | MIT |
| Last Refreshed: | 2025-02-05 03:17:49 |
| Package Statistics | |
|---|---|
| Total Downloads: | 3,303 |
| Monthly Downloads: | 0 |
| Daily Downloads: | 0 |
| Total Stars: | 6 |
| Total Watchers: | 5 |
| Total Forks: | 5 |
| Total Open Issues: | 0 |
This is a command line tool that generates markdown formatted release notes between two branches/tags.
Install the package globally via composer:
composer global require foodkit/automated-release-notes
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.
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