README
¶
ghch
Description
Generate changelog from git history, tags and merged pull requests
Installation
% go install github.com/Songmu/ghch/cmd/ghch@latest
Using aqua
% aqua g -i Songmu/ghch
Synopsis
% ghch -r /path/to/repo [--format markdown]
Options
-r, --repo= git repository path (default: .)
-f, --from= git commit revision range start from
-t, --to= git commit revision range end to
--latest output changes between latest two semantic versioned tags
-v, --verbose
-F, --format= json or markdown (default: json)
-A, --all output all changes
-N, --next-version=
-g, --git= git path (default: git)
--token= github token
--remote= default remote name (default: origin)
GITHUB Token
When github's api token is required in private repository etc., it is used in the following order of priority.
- command line option
--token - enviroment variable
GITHUB_TOKEN git config github.token
GitHub Enterprise
You can use ghch for GitHub Enterprise. Change API endpoint via the enviromental variable.
$ export GITHUB_API=http://github.company.com/api/v3
Requirements
git 1.8.5 or newer is required.
Examples
display changes from last versioned tag
% ghch
{
"pull_requests": [
{
"html_url": "https://github.com/mackerelio/mackerel-agent/pull/221",
"title": "Fix typo",
"number": 221,
"state": "closed",
"user": {
"login": "yukiyan",
"avatar_url": "https://avatars.githubusercontent.com/u/7304122?v=3",
"type": "User"
},
"body": "Just fixing a typo 😄 ",
"created_at": "2016-04-19T08:27:30Z",
"updated_at": "2016-04-25T01:51:15Z",
"merged_at": "2016-04-25T01:51:11Z",
...
"merged_by": {
"login": "stefafafan",
"avatar_url": "https://avatars.githubusercontent.com/u/3520520?v=3",
"type": "User"
}
},
...
],
"from_revision": "v0.30.2",
"to_revision": "",
"changed_at": "2016-04-27T19:05:49+09:00",
"owner": "mackerelio",
"repo": "mackerel-agent"
}
display changes from last versioned tag in markdown
% ghch --format=markdown --next-version=v0.30.3
## [v0.30.3](https://github.com/mackerelio/mackerel-agent/releases/tag/v0.30.3) (2016-04-27)
* retry retirement when api request failed [#224](https://github.com/mackerelio/mackerel-agent/pull/224) ([Songmu](https://github.com/Songmu))
* Fix comments [#222](https://github.com/mackerelio/mackerel-agent/pull/222) ([stefafafan](https://github.com/stefafafan))
* Remove go get cmd/vet [#223](https://github.com/mackerelio/mackerel-agent/pull/223) ([itchyny](https://github.com/itchyny))
* [nit] [plugin.checks.foo ] is valid toml now [#225](https://github.com/mackerelio/mackerel-agent/pull/225) ([Songmu](https://github.com/Songmu))
* Remove usr local bin again [#217](https://github.com/mackerelio/mackerel-agent/pull/217) ([Songmu](https://github.com/Songmu))
* Fix typo [#221](https://github.com/mackerelio/mackerel-agent/pull/221) ([yukiyan](https://github.com/yukiyan))
display changes between two tags semantic versioned in markdown
% ghch -F markdown --latest
## [v0.2.0](https://github.com/Songmu/ghch/compare/v0.1.3...v0.2.0) (2018-01-01)
* introduce goxz for releasing and drop goxc dependency [#17](https://github.com/Songmu/ghch/pull/17) ([Songmu](https://github.com/Songmu))
* add --latest option for output changes between latest two semantic versioned tags [#16](https://github.com/Songmu/ghch/pull/16) ([Songmu](https://github.com/Songmu))
* fill oldest commit hash when from ref is empty [#15](https://github.com/Songmu/ghch/pull/15) ([Songmu](https://github.com/Songmu))
display all changes
% ghch --format=markdown --next-version=v0.30.3 --all
...
display changes between specified two revisions
% ghch --from v0.9.0 --to v0.9.1
...
Author
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Changelog ¶
type Changelog struct {
Sections []Section `json:"Sections"`
}
Changelog contains Sectionst
type Ghch ¶ added in v0.5.0
type Ghch struct {
RepoPath string `short:"r" long:"repo" default:"." description:"git repository path"`
BaseURL string
GitPath string `short:"g" long:"git" default:"git" description:"git path"`
From string `short:"f" long:"from" description:"git commit revision range start from"`
To string `short:"t" long:"to" description:"git commit revision range end to"`
Latest bool ` long:"latest" description:"output changes between latest two semantic versioned tags"`
Token string ` long:"token" description:"github token"`
Verbose bool `short:"v" long:"verbose"`
Remote string ` long:"remote" default:"origin" description:"default remote name"`
Format string `short:"F" long:"format" description:"json or markdown"`
All bool `short:"A" long:"all" description:"output all changes"`
NextVersion string `short:"N" long:"next-version"`
Write bool `short:"w" description:"write result to file"`
ChangelogMd string
// Tmpl string
OutStream io.Writer
// contains filtered or unexported fields
}
Ghch is main application struct
type Section ¶
type Section struct {
PullRequests []*github.PullRequest `json:"pull_requests"`
FromRevision string `json:"from_revision"`
ToRevision string `json:"to_revision"`
ChangedAt time.Time `json:"changed_at"`
Owner string `json:"owner"`
Repo string `json:"repo"`
HTMLURL string `json:"html_url"`
}
Section contains changes between two revisions
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.