https://github.com/mortenscheel/release-notes-cli
Easily show Github release notes from the terminal
https://github.com/mortenscheel/release-notes-cli
cli github release-notes
Last synced: 20 days ago
JSON representation
Easily show Github release notes from the terminal
- Host: GitHub
- URL: https://github.com/mortenscheel/release-notes-cli
- Owner: mortenscheel
- Created: 2022-11-05T00:59:33.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-26T08:41:01.000Z (over 2 years ago)
- Last Synced: 2025-07-26T19:31:47.445Z (7 months ago)
- Topics: cli, github, release-notes
- Language: PHP
- Homepage:
- Size: 111 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Release notes CLI
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.
```shell
composer global require mortenscheel/release-notes-cli
```
#### Docker
```shell
docker run --rm -it mono2990/release-notes {repo}
```
You can optionally pass your Github token using an environment variable:
```shell
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 [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
```shell
release-notes laravel/framework
```
#### Show release notes for specific tag
```shell
release-notes laravel/framework --tag v9.34.0
```
#### Show all releases since specific version
```shell
release-notes laravel/framework --from 9.0
```
## Caching
To enable caching, run
```shell
release-notes cache:init
```
The cache can be flushed manually by running
```shell
release-notes cache:clear
```