https://github.com/digitalocean/github-changelog-generator

A tool to generate changelog entries from GitHub repositories.
https://github.com/digitalocean/github-changelog-generator

hacktoberfest

Last synced: 8 months ago
JSON representation

A tool to generate changelog entries from GitHub repositories.

• Host: GitHub
• URL: https://github.com/digitalocean/github-changelog-generator
• Owner: digitalocean
• License: apache-2.0
• Created: 2019-07-31T20:19:08.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2023-10-11T23:31:53.000Z (over 2 years ago)
• Last Synced: 2025-06-03T14:20:51.983Z (about 1 year ago)
• Topics: hacktoberfest
• Language: Go
• Homepage:
• Size: 685 KB
• Stars: 26
• Watchers: 13
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# GHCL – GitHub ChangeLog Generator

[![Build Status](https://github.com/digitalocean/github-changelog-generator/actions/workflows/test.yml/badge.svg)](https://github.com/digitalocean/github-changelog-generator/actions/workflows/test.yml)

A changelog generator for GitHub.

The generator works by,

  * Fetching the time of your repository's most recent release,

  * Fetching all pull requests merged _after_ the time of your most recent release,

  * Outputting a summary of those pull requests.

### Installation

`github-changelog-generator` must be installed from source. To install, run `go get -u github.com/digitalocean/github-changelog-generator`. A `github-changelog-generator` binary will then be available under your `$GOBIN` directory.

### Usage

```

Usage of github-changelog-generator

  -org string

    	organization (required)

  -repo string

    	repository (required)

  -token string

    	GitHub token (default env GITHUB_TOKEN)

  -url string

    	alternative GitHub API URL, must be a fully qualified URL with a trailing slash (optional)

```

The output is in the format `- # - @ - `. An example of the output is shown below.

```

- #3 - @some_contributor - update contibuting file

- #2 - @myteammate - update README.md

- #1 - @me - First PR

```

If there haven't been any changes to the repository since the latest release, the changelog generator will not show any output.

### Testing

Some tests use the network to test against real data. To avoid running these with the rest of the suite, use `go test -short ./...`. See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.

### License

GitHub changelog generator is [Apache-2.0 licensed](./LICENSE).