changelog

package module
Version: v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 31, 2021 License: Apache-2.0 Imports: 16 Imported by: 0

README

GitHub Changelog Generator

Apache 2.0 License Go Version Go Go Report Card Docker Pulls Lines of Code

Changelog is a cross-platform changelog generator for GitHub repositories. It queries between any two git branches or tags as supported by the GitHub Commits API, and generates a changelog of commits between the two. It supports templates for those who want more control over generated output.

Changelog's more advanced features support excluding commits from the changelog and grouping commits by heading based on regular expression patterns.

Usage

A GITHUB_TOKEN environment variable must be provided for changelog to operate effectively.

Usage:
  changelog [OPTIONS]

Application Options:
  -o, --owner=   GitHub Owner/Org name (required) [$GITHUB_OWNER]
  -r, --repo=    GitHub Repo name (required) [$GITHUB_REPO]
  -f, --from=    Begin changelog from this commit or tag
  -t, --to=      End changelog at this commit or tag (default: master)
  -c, --config=  Config file location for more advanced options beyond defaults
  -l, --local    Prefer local commits when gathering commit logs (as opposed to querying via API)
      --max=     The maximum number of commits to include
  -v, --version  Display version information

Help Options:
  -h, --help     Show this help message

The changelog output is written to standard output and can be redirected to overwrite or append to a file.

Limitations

As this tool uses GitHub's comparison API for details, there are a few limitations to output:

  • Limited to 250 commits
  • Limited to 5000 API requests per hour

See the GitHub Commits API for additional details.

Basic

The changelog generator doesn't assume a start or end tag, and doesn't evaluate existing tags to determine tag order. If from and to options are not provided, your changelog will result in the single latest commit on master.

You may specify GITHUB_OWNER and GITHUB_REPO as environment variables for use in CI.

Examples

Output for single latest commit on master

./changelog -o jimschubert -r changelog -f master~1 -t master

Output from some version to latest master

./changelog -o jimschubert -r changelog -f v0.1

Sample output from one version to another

./changelog -o jimschubert -r kopper -f v0.0.2 -t v0.0.3

## v0.0.3

* [d12243c81d](https://github.com/jimschubert/kopper/commit/d12243c81d6b4b45547929d97e49277d1cae4110) Bump version 0.0.3 ([jimschubert](https://github.com/jimschubert))
* [41f8fafd25](https://github.com/jimschubert/kopper/commit/41f8fafd25ff336f0de2f16c91ec199aec577843) Support name/description in TypedArgumentParser ([jimschubert](https://github.com/jimschubert))
* [91b5f02d99](https://github.com/jimschubert/kopper/commit/91b5f02d9918e769493fbeb22fe0ff884ac99b67) Support writing directly to PrintStream ([jimschubert](https://github.com/jimschubert))
* [ec986bff99](https://github.com/jimschubert/kopper/commit/ec986bff995507c92f10f74b6acae840eb5ab1dc) 0.0.3-SNAPSHOT ([jimschubert](https://github.com/jimschubert))


<em>For more details, see <a href="https://github.com/jimschubert/kopper/compare/v0.0.2...v0.0.3">v0.0.2..v0.0.3</a></em>
Templating

The default template used in basic usage will output Markdown in flatten or grouped display (see later for configuration options). The template is defined as:

{{define "GroupTemplate" -}}
{{- range .Grouped}}
### {{ .Name }}

{{range .Items -}}
* [{{.CommitHashShort}}]({{.CommitURL}}) {{.Title}} ({{if .IsPull}}[contributed]({{.PullURL}}) by {{end}}[{{.Author}}]({{.AuthorURL}}))
{{end -}}
{{end -}}
{{end -}}
{{define "FlatTemplate" -}}
{{range .Items -}}
* [{{.CommitHashShort}}]({{.CommitURL}}) {{.Title}} ({{if .IsPull}}[contributed]({{.PullURL}}) by {{end}}[{{.Author}}]({{.AuthorURL}}))
{{end -}}
{{end -}}
{{define "DefaultTemplate" -}}
## {{.Version}}
{{if len .Grouped -}}
{{template "GroupTemplate" . -}}   
{{- else}}
{{template "FlatTemplate" . -}}
{{end}}
<em>For more details, see <a href="{{.CompareURL}}">{{.PreviousVersion}}..{{.Version}}</a></em>
{{end -}}
{{template "DefaultTemplate" . -}}

Groupings will be displayed in the order they're defined in your external configuration.

You must define an external JSON configuration file to override the default template. For example, suppose you want to display flat commit history and link to diff, patch, and compare URLs. You could define a template like so:

## {{.Version}}

{{range .Items -}}
* [{{.CommitHashShort}}]({{.CommitURL}}) {{.Title}} ({{if .IsPull}}[contributed]({{.PullURL}}) by {{end}}[{{.Author}}]({{.AuthorURL}}))
{{end}}

### Links
<ul>
<li><a href="{{.CompareURL}}">Compare {{.PreviousVersion}}..{{.Version}}</a></li>
<li><a href="{{.DiffURL}}">Diff {{.PreviousVersion}}..{{.Version}}</a></li>
<li><a href="{{.PatchURL}}">Patch {{.PreviousVersion}}..{{.Version}}</a></li>
</ul>

Install

Latest binary releases are available via GitHub Releases.

Docker

The preferred way to run changelog is via Docker. For example:

docker pull jimschubert/changelog:latest
docker run -e GITHUB_TOKEN=yourtoken \
           -e GITHUB_OWNER=jimschubert \
           -e GITHUB_REPO=changelog \
   jimschubert/changelog:latest -f v0.1 -t v0.2 >> CHANGELOG.md
Homebrew
brew tap jimschubert/tap
brew install changelog

Advanced

More advanced scenarios require an external JSON configuration object which can be loaded by the --config option. The following example properties are supported by the config (comments added inline for brevity):

{
  // "commits" or "prs", defaults to commits. "prs" will soon allow for resolving labels 
  // from pull requests
  "resolve": "commits",

  // "asc" or "desc", determines the order of commits in the output
  "sort": "asc",
  
  // GitHub user or org name
  "owner": "jimschubert",  
   
  // Repository name
  "repo": "changelog",

  // Enterprise GitHub base url
  "enterprise": "https://ghe.example.com",

  // Path to custom template following Go Text template syntax
  "template": "/path/to/your/template",

  // Group commits by headings based on patterns supporting Perl syntax regex or plain text
  "groupings": [
    { "name":  "Contributions", "patterns":  [ "(?i)\\bfeat\\b" ] }
  ],

  // Exclude commits based on this set of patterns or texts
  // (useful for common maintenance commit messages)
  "exclude": [
    "^(?i)release\\s+\\d+\\.\\d+\\.\\d+",
    "^(?i)minor fix\\b",
    "^(?i)wip\\b"
  ],
   
  // Prefers local commits over API. Requires executing from within a Git repository.
  "local": false,
 
  // Processes UP TO this many commits before processing exclusion/inclusion rules. Defaults to size returned from GitHub API.
  "max_commits": 250
}
Custom templating

Grouping is done by the name property of the groupings array objects, in the order in which groupings are declared. Groupings are displayed by default, but suppose you want to provide a custom template to display grouping differently. In this example, we'll only display the author name if the commit comes from a pull request.

First, create a directory at /tmp/changelog to contain a sample JSON and template.

Save the follow template as template.tmpl:

## {{.Version}}

{{range .Grouped -}}
### {{ .Name }}

{{range .Items -}}
* [{{.CommitHashShort}}]({{.CommitURL}}) {{.Title}}{{if .IsPull}} ([contributed]({{.PullURL}}) by [{{.Author}}]({{.AuthorURL}})){{end}}
{{end}}
{{end}}

<em>For more details, see <a href="{{.CompareURL}}">{{.PreviousVersion}}..{{.Version}}</a></em>

Save the following as config.json (note: template currently requires a full path to the template file):

{
  "sort": "desc",
  "template": "/tmp/changelog/template.tmpl",
  "groupings": [
    {
      "name": "Fixes",
      "patterns": [
        "(?i)\\bbug\\b",
        "(?i)\\bfix\\b"
      ]
    },
    {
      "name": "Features",
      "patterns": [
        "^(?i)feat:\\b",
        "^(?i)add:\\b"
      ]
    },
    {
      "name": "Cleanup",
      "patterns": [
        "(?i)\\brefactor:\\b"
      ]
    },
    {
      "name": "Other Contributions",
      "patterns": [
        ".?"
      ]
    }
  ],
  "exclude": [
    "(?i)readme\\b",
    "(?i)\\b>\\b",
    "(?i)\\btypo\\b",
    "^usage$",
    "Bump dependencies",
    "minor",
    "slight"
  ]
}

Now, run this against cli/cli v0.5.6 and v0.5.7. Via Docker:

docker run -e GITHUB_TOKEN=yourtoken \
   -e GITHUB_OWNER=cli \
   -e GITHUB_REPO=cli \
   jimschubert/changelog:latest -f v0.5.6 -t v0.5.7 >> /tmp/changelog/CHANGELOG.md

And via cli:

export GITHUB_TOKEN=your-token 
./changelog -o cli -r cli -f v0.5.6 -t v0.5.7 \
    -c /tmp/changelog/config.json >> /tmp/changelog/CHANGELOG.md

This changelog output in /tmp/changelog/CHANGELOG.md should look like this:

## v0.5.7

### Fixes

* [f9649ebddd](https://github.com/cli/cli/commit/f9649ebddd1b6a9731046c98cd8019a245c82fde) Merge pull request #521 from yashLadha/bug/issue_list_on_no_remote ([contributed](https://github.com/cli/cli/pull/521) by [mislav](https://github.com/mislav))
* [4ee995dafd](https://github.com/cli/cli/commit/4ee995dafdf98730c292c63c1b8a0fab5f2198d1) fix(486): Getting issue list on no remotes specified
* [4c3e498021](https://github.com/cli/cli/commit/4c3e498021997b40d3c78f8c858ed734f819b064) Fix column alignment and truncation for Eastern Asian languages

### Other Contributions

* [b5d0b7c640](https://github.com/cli/cli/commit/b5d0b7c640ad897f395a72074a0f4b31787e5826) Merge pull request #523 from cli/title-body-web ([contributed](https://github.com/cli/cli/pull/523) by [mislav](https://github.com/mislav))
* [1a82e39ba9](https://github.com/cli/cli/commit/1a82e39ba9627654aca22e9608d5b81589855d41) Respect title & body from arguments to `pr create -w`
* [69304ce9af](https://github.com/cli/cli/commit/69304ce9af6100e49bb6a128a81639d48ac590ec) Merge pull request #518 from cli/eastern-asian ([contributed](https://github.com/cli/cli/pull/518) by [mislav](https://github.com/mislav))
* [4727fc4659](https://github.com/cli/cli/commit/4727fc465982d3029324fc5b77ee37e28c29a2b3) Ensure descriptive error when no github.com remotes found



<em>For more details, see <a href="https://github.com/cli/cli/compare/v0.5.6...v0.5.7">v0.5.6..v0.5.7</a></em>

Notice that this differs from the default in that it removes the committer name from the two commits in each section which were not pull requests.

Debugging

You may debug select operations such as groupings and exclusions by exporting LOG_LEVEL=debug.

License

This project is licensed under Apache 2.0.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Changelog

type Changelog struct {
	*model.Config
	From string
	To   string
}

Changelog holds the information required to define the bounds for the changelog

func (*Changelog) Generate

func (c *Changelog) Generate(writer io.Writer) error

Generate will format a changelog, writing to the supplied writer

func (*Changelog) GetGitURLs

func (c *Changelog) GetGitURLs() (*model.GitURLs, error)

type CommitAscendingSorter

type CommitAscendingSorter []model.ChangeItem

func (CommitAscendingSorter) Len

func (a CommitAscendingSorter) Len() int

func (CommitAscendingSorter) Less

func (a CommitAscendingSorter) Less(i, j int) bool

func (CommitAscendingSorter) Swap

func (a CommitAscendingSorter) Swap(i, j int)

type CommitDescendingSorter

type CommitDescendingSorter []model.ChangeItem

func (CommitDescendingSorter) Len

func (a CommitDescendingSorter) Len() int

func (CommitDescendingSorter) Less

func (a CommitDescendingSorter) Less(i, j int) bool

func (CommitDescendingSorter) Swap

func (a CommitDescendingSorter) Swap(i, j int)

Source Files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL