https://github.com/shiimaxx/glch
CLI tool for generating changelog based on GitLab Merge Request
https://github.com/shiimaxx/glch
changelog gitlab golang
Last synced: about 1 month ago
JSON representation
CLI tool for generating changelog based on GitLab Merge Request
- Host: GitHub
- URL: https://github.com/shiimaxx/glch
- Owner: shiimaxx
- License: mit
- Created: 2020-05-07T09:32:10.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-12-11T21:00:52.000Z (3 months ago)
- Last Synced: 2025-12-13T01:38:21.533Z (3 months ago)
- Topics: changelog, gitlab, golang
- Language: Go
- Homepage:
- Size: 38.1 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# glch
`glch` generates changelog based on GitLab Merge Request.
## Usage
Run the `glch` after you moved to the GitLab project root directory.
```
$ glch [--latest|--only version|--next-version version]
```
You can use the following options.
- `--latest`
- Display changelog for the most recent version only
- `--only version`
- Display changelog for the specified versin only
- `--next-version version`
- Set the next version (default is "Unreleased")
## GitLab Token
Please set your GitLab Token when using in a private project. You can get GitLab Token from [this page](https://gitlab.com/profile/personal_access_tokens).
```
$ export GITLAB_TOKEN=...
```
## GitLab API Endpoint
Default GitLab API Endpoint is `https://gitlab.com/api/v4/`. You can change it via GITLAB_API.
```
export GITLAB_API=https://gitlab.example.com/api/v4/
```
## Format of the changelog
`glch` will generate a changelog following format that based on 「[keep a changelog](https://keepachangelog.com/)」
```
## Version - YYYY-MM-DD
- from @
- ...
```
## Install
- Download binary from [release page](https://github.com/shiimaxx/glch/releases)
- Copy binary to `$PATH` directory