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 2 months 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 (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-18T22:07:13.000Z (about 2 months ago)
• Last Synced: 2024-11-18T23:19:41.969Z (about 2 months ago)
• Topics: changelog, gitlab, golang
• Language: Go
• Homepage:
• Size: 32.2 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# glch

![CI](https://github.com/shiimaxx/glch/workflows/CI/badge.svg)

`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