mortenscheel / release-notes-cli
Show formatted Github release notes in the terminal.
Installs: 35
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Type:project
Requires
- php: ^8.1
- composer/semver: ^3.3
- guzzlehttp/guzzle: ^7.5
- illuminate/database: ^10.6
- laravel-zero/framework: ^10.0.2
- league/commonmark: ^2.4
- nunomaduro/termwind: ^1.15.1
- sammyjo20/saloon-laravel: ^2.0
Requires (Dev)
- ergebnis/composer-normalize: ^2.30
- fakerphp/faker: ^1.21.0
- laravel/pint: ^1.8
- mockery/mockery: ^1.5.1
- nunomaduro/larastan: ^2.5
- pestphp/pest: ^2.4
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