PHPackages                             guywithnose/release-notes - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. guywithnose/release-notes

ActiveLibrary

guywithnose/release-notes
=========================

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

v1.1.3(6y ago)19359[17 issues](https://github.com/guywithnose/release-notes/issues)MITPHPPHP ~7.0CI failing

Since May 8Pushed 4y ago2 watchersCompare

[ Source](https://github.com/guywithnose/release-notes)[ Packagist](https://packagist.org/packages/guywithnose/release-notes)[ RSS](/packages/guywithnose-release-notes/feed)WikiDiscussions master Synced 6d ago

READMEChangelog (10)Dependencies (13)Versions (22)Used By (0)

Release Notes builder tool
==========================

[](#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.

Basic Usage
-----------

[](#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.

```
$ 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`

```
$ bin/buildRelease --help
```

Github Integration
------------------

[](#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.

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.

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.

Jira Integration
----------------

[](#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.

Start by copying .env.dist to .env and modifying with your information.

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.

###  Health Score

28

↓

LowBetter than 54% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity19

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~194 days

Recently: every ~346 days

Total

12

Last Release

2261d ago

Major Versions

v0.3.1 → v1.0.02016-05-25

### Community

Maintainers

![](https://www.gravatar.com/avatar/57b0c44fadeabc6b233d8d6c1e15d14229e1dc744ade13fc83f461dd126e7b24?d=identicon)[guywithnose](/maintainers/guywithnose)

---

Top Contributors

[![chrisryan](https://avatars.githubusercontent.com/u/704326?v=4)](https://github.com/chrisryan "chrisryan (26 commits)")[![nubs](https://avatars.githubusercontent.com/u/57673?v=4)](https://github.com/nubs "nubs (18 commits)")[![guywithnose](https://avatars.githubusercontent.com/u/1059169?v=4)](https://github.com/guywithnose "guywithnose (16 commits)")

---

Tags

releasegithub

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/guywithnose-release-notes/health.svg)

```
[![Health](https://phpackages.com/badges/guywithnose-release-notes/health.svg)](https://phpackages.com/packages/guywithnose-release-notes)
```

###  Alternatives

[magento/community-edition

Magento 2 (Open Source)

12.1k52.1k10](/packages/magento-community-edition)[illuminate/console

The Illuminate Console package.

12944.1M5.1k](/packages/illuminate-console)[liip/rmt

Release Management Tool: a handy tool to help releasing new version of your software

457448.7k74](/packages/liip-rmt)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)[moodlehq/moodle-plugin-ci

Helps running Moodle plugins analysis checks and tests under various CI environments.

612.6M](/packages/moodlehq-moodle-plugin-ci)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)