From b44eb4e011bbca8a23a6b3217abc6ec7d6d93833 Mon Sep 17 00:00:00 2001 From: Derek Smith Date: Wed, 24 Mar 2021 16:59:08 -0500 Subject: [PATCH] chore(CHANGELOG): regenerate CHANGELOG with type-scope and KAC template (#129) --- .chglog/CHANGELOG.tpl.md | 7 ++ .chglog/config.yml | 5 +- CHANGELOG.md | 191 +++++++++++++++++++++++++++++++++------ Makefile | 4 +- 4 files changed, 174 insertions(+), 33 deletions(-) diff --git a/.chglog/CHANGELOG.tpl.md b/.chglog/CHANGELOG.tpl.md index 389e9789..5683d039 100755 --- a/.chglog/CHANGELOG.tpl.md +++ b/.chglog/CHANGELOG.tpl.md @@ -29,6 +29,13 @@ {{ end }} {{ end -}} +{{- if .MergeCommits -}} +### Pull Requests +{{ range .MergeCommits -}} +- {{ .Header }} +{{ end }} +{{ end -}} + {{- if .NoteGroups -}} {{ range .NoteGroups -}} ### {{ .Title }} diff --git a/.chglog/config.yml b/.chglog/config.yml index abfce168..074a182c 100755 --- a/.chglog/config.yml +++ b/.chglog/config.yml @@ -11,16 +11,19 @@ options: - fix - perf - refactor + - chore commit_groups: title_maps: feat: Features fix: Bug Fixes perf: Performance Improvements refactor: Code Refactoring + chore: Chores header: - pattern: "^(\\w*)\\:\\s(.*)$" + pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$" pattern_maps: - Type + - Scope - Subject notes: keywords: diff --git a/CHANGELOG.md b/CHANGELOG.md index 413a6068..d01f571c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,18 +1,21 @@ -# CHANGELOG -All notable changes to this project will be documented in this file. -This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html) - ## [Unreleased] + ## [v0.13.0] - 2021-03-23 +### Chores +- update changelog for v0.13.0 +- use ldflags to pass version to build process ([#127](https://github.com/git-chglog/git-chglog/issues/127)) + ### Features - add support for rendering .Body after .Subject as part of list ([#121](https://github.com/git-chglog/git-chglog/issues/121)) + ## [v0.12.0] - 2021-03-20 -### Chore +### Chores +- update changelog for v0.12.0 - bumps version to v0.12.0 - bump golang to 1.16 ([#118](https://github.com/git-chglog/git-chglog/issues/118)) - **ci:** add golangci-lint action and apply linting changes ([#120](https://github.com/git-chglog/git-chglog/issues/120)) @@ -24,39 +27,79 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html `JiraIssueId` has been renamed to `JiraIssueID`. This impacts the value for `pattern_maps` in `config.yml`. +* chore(ci): add golangci-lint action + +* chore(lint): address errcheck lint failures + +* chore(lint): address misspell lint failures + +* chore(lint): address gocritic lint failures + +* chore(lint): address golint lint failures + +* chore(lint): address structcheck lint failures + +* chore(lint): address gosimple lint failures + +* chore(lint): address gofmt lint failures + +* chore(ci): port to official golangci-lint github action + +* Update golangci configuration for better coverage + + ## [v0.11.2] - 2021-03-13 ### Bug Fixes - `--template` and `--repository-url` flags not being used ([#119](https://github.com/git-chglog/git-chglog/issues/119)) +### Chores +- update changelog for v0.11.2 +- bumps version to v0.11.2 + + ## [v0.11.1] - 2021-03-12 - ### Bug Fixes -- **short flags**: correctly define cli flags with shorthands ([#117](https://github.com/git-chglog/git-chglog/issues/117)) +- **short flags:** correctly define cli flags with shorthands ([#117](https://github.com/git-chglog/git-chglog/issues/117)) + +### Chores +- update readme and changelog for v0.11.1 +- bumps version to v0.11.1 + ## [v0.11.0] - 2021-03-12 +### Bug Fixes +- **deps:** update all non-major dependencies ([#115](https://github.com/git-chglog/git-chglog/issues/115)) +- **deps:** update module gopkg.in/kyokomi/emoji.v1 to github.com/kyokomi/emoji/v2 ([#109](https://github.com/git-chglog/git-chglog/issues/109)) +- **deps:** update module github.com/urfave/cli to v2 ([#107](https://github.com/git-chglog/git-chglog/issues/107)) +- **deps:** update module github.com/stretchr/testify to v1.7.0 ([#103](https://github.com/git-chglog/git-chglog/issues/103)) +- **deps:** update module gopkg.in/alecaivazis/survey.v1 to github.com/AlecAivazis/survey/v2 ([#108](https://github.com/git-chglog/git-chglog/issues/108)) +- **init:** support OptionAnswer form in survey/v2 ([#113](https://github.com/git-chglog/git-chglog/issues/113)) + +### Chores +- update changelog for v0.11.0 +- bumps version to v0.11.0 +- **deps:** add initial renovatebot configuration ([#102](https://github.com/git-chglog/git-chglog/issues/102)) + ### Features - add Jira integration ([#52](https://github.com/git-chglog/git-chglog/issues/52)) +- **flag:** --path filtering - refs ([#62](https://github.com/git-chglog/git-chglog/issues/62)). Closes [#35](https://github.com/git-chglog/git-chglog/issues/35) + ## [v0.10.0] - 2021-01-16 - -### BREAKING CHANGE -We adapted the naming schema of the uploaded binaries by adding a `v` prefix for tags/versions starting from `v0.10.0`: -``` -# up to 0.9.1 -https://github.com/git-chglog/git-chglog/releases/download//git-chglog__ - -# from v0.10.0 -https://github.com/git-chglog/git-chglog/releases/download/v/git-chglog__ - -``` - ### Bug Fixes - ignore only git-chglog binary in root and not subfolder +### Chores +- update changelog for v0.10.0 +- bumps version to v0.10.0 +- sorts changelog desc and excludes Merge commits +- fix Makefile typo ([#82](https://github.com/git-chglog/git-chglog/issues/82)) +- **asdf:** add asdf install support to README ([#79](https://github.com/git-chglog/git-chglog/issues/79)) + ### Features - Adds 'Custom' sort_type to CommitGroup ([#69](https://github.com/git-chglog/git-chglog/issues/69)) - enable tag_filter_pattern in config options ([#72](https://github.com/git-chglog/git-chglog/issues/72)) @@ -65,6 +108,16 @@ https://github.com/git-chglog/git-chglog/releases/download/v/git-chglog - add upperFirst template function - Add emoji format and some formatters in variables +### Reverts +- Revert "ci: switches to personal GH Token for brew cross repo releases" +- ci: switches to personal GH Token for brew cross repo releases + +### Pull Requests +- Merge pull request [#65](https://github.com/git-chglog/git-chglog/issues/65) from barryib/case-sensitive-option +- Merge pull request [#59](https://github.com/git-chglog/git-chglog/issues/59) from momotaro98/feature/add-emoji-template-in-init +- Merge pull request [#66](https://github.com/git-chglog/git-chglog/issues/66) from barryib/add-upper-first-func +- Merge pull request [#68](https://github.com/git-chglog/git-chglog/issues/68) from unixorn/tweak-readme + ## [0.9.1] - 2019-09-23 @@ -77,49 +130,84 @@ https://github.com/git-chglog/git-chglog/releases/download/v/git-chglog ### Features - Add --tag-filter-pattern flag. +### Pull Requests +- Merge pull request [#44](https://github.com/git-chglog/git-chglog/issues/44) from evanchaoli/tag-filter +- Merge pull request [#41](https://github.com/git-chglog/git-chglog/issues/41) from StanleyGoldman/fixing-tests-windows +- Merge pull request [#37](https://github.com/git-chglog/git-chglog/issues/37) from ForkingSyndrome/master + ## [0.8.0] - 2019-02-23 ### Features - add the contains, hasPrefix, hasSuffix, replace, lower and upper functions to the template functions map +### Pull Requests +- Merge pull request [#34](https://github.com/git-chglog/git-chglog/issues/34) from atosatto/template-functions + ## [0.7.1] - 2018-11-10 ### Bug Fixes - Panic occured when exec --next-tag with HEAD with tag +### Pull Requests +- Merge pull request [#31](https://github.com/git-chglog/git-chglog/issues/31) from drubin/patch-1 +- Merge pull request [#30](https://github.com/git-chglog/git-chglog/issues/30) from vvakame/fix-panic + ## [0.7.0] - 2018-05-06 ### Bug Fixes - Remove accidentally added `Unreleased.Tag` +### Chores +- Update `changelog` task in Makefile + ### Features - Add URL of output example for template style - Add `--next-tag` flag (experimental) +### Pull Requests +- Merge pull request [#22](https://github.com/git-chglog/git-chglog/issues/22) from git-chglog/feat/add-preview-style-link +- Merge pull request [#21](https://github.com/git-chglog/git-chglog/issues/21) from git-chglog/feat/next-tag + ## [0.6.0] - 2018-05-04 +### Chores +- Update CHANGELOG template format + ### Features - Add tag name header id for keep-a-changelog template +### Pull Requests +- Merge pull request [#20](https://github.com/git-chglog/git-chglog/issues/20) from git-chglog/feat/kac-template-title-id + ## [0.5.0] - 2018-05-04 ### Bug Fixes - Add unreleased commits section to keep-a-changelog template [#15](https://github.com/git-chglog/git-chglog/issues/15) +### Chores +- Update CHANGELOG template format + ### Features - Update template format to human readable - Add `Unreleased` field to `RenderData` +### Pull Requests +- Merge pull request [#19](https://github.com/git-chglog/git-chglog/issues/19) from git-chglog/fix/unreleased-commits +- Merge pull request [#18](https://github.com/git-chglog/git-chglog/issues/18) from ringohub/master + ## [0.4.0] - 2018-04-14 ### Features -- Add support for Bitbucket :tada: +- Add support for Bitbucket + +### Pull Requests +- Merge pull request [#17](https://github.com/git-chglog/git-chglog/issues/17) from git-chglog/feat/bitbucket @@ -127,42 +215,69 @@ https://github.com/git-chglog/git-chglog/releases/download/v/git-chglog ### Features - Change to kindly error message when git-tag does not exist +### Pull Requests +- Merge pull request [#16](https://github.com/git-chglog/git-chglog/issues/16) from git-chglog/fix/empty-tag-handling + ## [0.3.2] - 2018-04-02 ### Bug Fixes - Fix color output bug in windows help command +### Pull Requests +- Merge pull request [#14](https://github.com/git-chglog/git-chglog/issues/14) from git-chglog/fix/windows-help-color + ## [0.3.1] - 2018-03-15 ### Bug Fixes -- Fix preview string of commit subject ([@kt3k](https://github.com/kt3k)) +- fix preview string of commit subject + +### Pull Requests +- Merge pull request [#13](https://github.com/git-chglog/git-chglog/issues/13) from kt3k/feature/fix-preview ## [0.3.0] - 2018-03-12 +### Chores +- Add helper task for generate CHANGELOG + ### Features -- Add support for GitLab :tada: +- Add support for GitLab + +### Pull Requests +- Merge pull request [#12](https://github.com/git-chglog/git-chglog/issues/12) from git-chglog/feat/gitlab ## [0.2.0] - 2018-03-02 +### Chores +- Fix release flow (retry) +- Add AppVeyor config + ### Features - Add template for `Keep a changelog` to the `--init` option - Supports vim like `j/k` keybind with item selection of `--init` -### Bug Fixes -- Support Windows colors :tada: ([@mattn](https://github.com/mattn)) -- Fixed several bugs in Windows +### Pull Requests +- Merge pull request [#11](https://github.com/git-chglog/git-chglog/issues/11) from git-chglog/develop +- Merge pull request [#10](https://github.com/git-chglog/git-chglog/issues/10) from mattn/fix-test +- Merge pull request [#9](https://github.com/git-chglog/git-chglog/issues/9) from mattn/windows-color ## [0.1.0] - 2018-02-25 ### Bug Fixes +- Fix a bug that `Commit.Revert.Header` is not converted by `GitHubProcessor` - Fix error message when `Tag` can not be acquired - Fix `Revert` of template created by Initializer +### Chores +- Fix release scripts +- Remove unnecessary task +- Add coverage measurement task for local confirmation +- Change release method of git tag on TravisCI + ### Code Refactoring - Refactor `Initializer` to testable @@ -172,14 +287,19 @@ https://github.com/git-chglog/git-chglog/releases/download/v/git-chglog - Add Git Basic to commit message format - Add preview to the commit message format of `--init` option +### Pull Requests +- Merge pull request [#8](https://github.com/git-chglog/git-chglog/issues/8) from git-chglog/feat/0.0.3 +- Merge pull request [#6](https://github.com/git-chglog/git-chglog/issues/6) from git-chglog/chore/coverage +- Merge pull request [#4](https://github.com/git-chglog/git-chglog/issues/4) from paralax/patch-1 +- Merge pull request [#5](https://github.com/git-chglog/git-chglog/issues/5) from git-chglog/develop +- Merge pull request [#1](https://github.com/git-chglog/git-chglog/issues/1) from git-chglog/develop + ## [0.0.2] - 2018-02-18 -### Bug Fixes -- Fix a bug that `Commit.Revert.Header` is not converted by `GitHubProcessor` - -### Features -- Add preview to the commit message format of `--init` option +### Chores +- Fix release script +- Add release process @@ -187,6 +307,17 @@ https://github.com/git-chglog/git-chglog/releases/download/v/git-chglog ### Bug Fixes - Fix parsing of revert and body +### Chores +- Fix timezone in TravisCI +- Add travis configuration +- Add Makefile for task management +- Fix testcase depending on datetime +- Update vendor packages +- Add e2e tests +- Setup gitignore +- Initial commit +- **editor:** Add Editorconfig + ### Code Refactoring - Fix typo - Change to return an error if corresponding commit is empty diff --git a/Makefile b/Makefile index 02281c52..cc5b6c0b 100644 --- a/Makefile +++ b/Makefile @@ -22,8 +22,8 @@ install: go install ./cmd/git-chglog .PHONY: changelog -changelog: - @git-chglog --next-tag $(tag) $(tag) +changelog: build + ./git-chglog --next-tag $(VERSION) -o CHANGELOG.md .PHONY: lint lint: