Skip to content
/ glch Public

CLI tool for generating changelog based on GitLab Merge Request

License

Notifications You must be signed in to change notification settings

shiimaxx/glch

Folders and files

NameName
Last commit message
Last commit date
Dec 11, 2022
May 7, 2020
Mar 21, 2021
May 7, 2020
Mar 21, 2021
Mar 21, 2021
Mar 21, 2021
Mar 21, 2021
Mar 21, 2021
Dec 10, 2022
Jun 14, 2023
Jun 14, 2023
Dec 10, 2022
Mar 21, 2021

Repository files navigation

glch

CI

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.

$ 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

## Version - YYYY-MM-DD

- <Merge Request title> <Reference> from @<Author>
- ...

Install

  • Download binary from release page
  • Copy binary to $PATH directory