README

A command-line tool to find and show the release notes for a specific Github repository or Composer package.

Installation

Composer

Requirements: Linux or Mac with PHP 8.1 and Composer installed.

composer global require mortenscheel/release-notes-cli

Docker

docker run --rm -it mono2990/release-notes {repo}

You can optionally pass your Github token using an environment variable:

docker run --rm -it -e RELEASE_NOTES_GITHUB_TOKEN={token} mono2990/release-notes {repo}

Caching is not supported when running in docker

Usage

release-notes <name> [options]

Arguments:
  name                  Name of the repository or package

Options:
  --tag[=TAG]           Specific tag
  --from[=FROM]         From version
  --to[=TO]             To version
  --help                Display help
  
Note:
  If neither --tag, --from or --too is provided, only the latest release will be displayed

Show latest release notes

release-notes laravel/framework

Show release notes for specific tag

release-notes laravel/framework --tag v9.34.0

Show all releases since specific version

release-notes laravel/framework --from 9.0

Caching

To enable caching, run

release-notes cache:init

The cache can be flushed manually by running

release-notes cache:clear