-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0156c3c
commit d07ad2c
Showing
5 changed files
with
172 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{{ range .Versions }} | ||
{{ if .Tag.Previous }}{{ .Tag.Name }}{{ else }}{{ .Tag.Name }}{{ end }} | ||
--- | ||
{{ range .CommitGroups -}} | ||
* **{{ .Title }}** | ||
|
||
{{ range .Commits -}} | ||
* {{ if .Scope }}**>{{ .Scope }}:<** {{ end }}{{ .Subject }} | ||
{{ end }} | ||
{{ end -}} | ||
|
||
{{- if .NoteGroups -}} | ||
{{ range .NoteGroups -}} | ||
### {{ .Title }} | ||
|
||
{{ range .Notes }} | ||
{{ .Body }} | ||
{{ end }} | ||
{{ end -}} | ||
{{ end -}} | ||
{{ end -}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Creating a changelog automatically | ||
|
||
## Install and configure tool | ||
|
||
We using <https://github.com/git-chglog/git-chglog>, so refer to this side for installation instructions. | ||
|
||
## Usage | ||
|
||
Example for a new release "v2.0.0": | ||
|
||
```sh | ||
git fetch --tags | ||
git-chglog --no-case --next-tag 2.0.0 v1.16.0.. > .chglog/chglog_tmp.md | ||
``` | ||
|
||
## Compare | ||
|
||
If unsure about any result of running git-chglog, just use: | ||
`git log --since=2022-05-02 --pretty="- %s` | ||
|
||
## Manual adjustment | ||
|
||
Because there is no commit style guide yet, some manual work is needed to bring the items in the correct position. | ||
Please refer to the current CHANGELOG.md to find the correct way. In general we try to use this style: | ||
|
||
* titles will be converted to lower case | ||
* titles are lexical ordered | ||
* each platform has its own title (e.g. **raspi**) | ||
* fixes has the title **bugfix** | ||
* title **api**, **drivers** or **example** is used for changes below related folder | ||
* title **core** is used for changes of common code, e.g. utilities, system | ||
* further special titles **build**, **docs** and **test** can be used | ||
|
||
## Finalization | ||
|
||
After all work is done in the temporary changelog file, the content can be moved to the real one and the "chglog_tmp.md" | ||
file can be removed. | ||
|
||
## TODO's | ||
|
||
* introduce a commit style guide | ||
* convert the changelog format to a more common style, see <https://github.com/git-chglog/example-type-scope-subject/tree/master> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
style: github | ||
template: CHANGELOG.gobot.md | ||
info: | ||
title: CHANGELOG | ||
repository_url: https://github.com/hybridgroup/gobot | ||
options: | ||
commits: | ||
# filters: | ||
# Type: | ||
# - feat | ||
# - fix | ||
# - perf | ||
# - refactor | ||
commit_groups: | ||
# title_maps: | ||
# feat: Features | ||
# fix: Bug Fixes | ||
# perf: Performance Improvements | ||
# refactor: Code Refactoring | ||
header: | ||
pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:?\\s(.*)$" | ||
pattern_maps: | ||
- Type | ||
- Scope | ||
- Subject | ||
notes: | ||
keywords: | ||
- BREAKING CHANGE |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters