Add chngelog generator basics

This commit is contained in:
Thomas Boerger
2019-09-04 16:38:16 +02:00
parent a05402b612
commit 552ab115cf
4 changed files with 52 additions and 0 deletions

28
changelog/CHANGELOG.tmpl Normal file
View File

@@ -0,0 +1,28 @@
{{- range $changes := . }}{{ with $changes -}}
# Changelog for {{ .Version }}
The following sections list the changes for {{ .Version }}.
## Summary
{{ range $entry := .Entries }}{{ with $entry }}
* {{ .TypeShort }} #{{ .PrimaryID }}: {{ .Title }}
{{- end }}{{ end }}
## Details
{{ range $entry := .Entries }}{{ with $entry }}
* {{ .Type }} #{{ .PrimaryID }}: {{ .Title }}
{{ range $par := .Paragraphs }}
{{ wrap $par 80 3 }}
{{ end -}}
{{ range $url := .IssueURLs }}
{{ $url -}}
{{ end -}}
{{ range $url := .PRURLs }}
{{ $url -}}
{{ end -}}
{{ range $url := .OtherURLs }}
{{ $url -}}
{{ end }}
{{ end }}{{ end }}
{{ end }}{{ end -}}

7
changelog/README.md Normal file
View File

@@ -0,0 +1,7 @@
# Changelog
We are using [calens](https://github.com/restic/calens) to properly generate a
changelog before we are tagging a new release. To update the changelog copy the
files from the [unreleased](./unreleased) folder into a folder matching the
schema `0.1.0_2019-09-01` to tag and execute `calens` in the root folder of the
project.

11
changelog/TEMPLATE Normal file
View File

@@ -0,0 +1,11 @@
Bugfix: Fix behavior for foobar (in present tense)
We've fixed the behavior for foobar, a long-standing annoyance for users. The
text should be wrapped at 80 characters length.
The text in the paragraphs is written in past tense. The last section is a list
of issue URLs, PR URLs and other URLs. The first issue ID (or the first PR ID,
in case there aren't any issue links) is used as the primary ID.
https://github.com/owncloud/reva-hyper/issues/1234
https://github.com/owncloud/reva-hyper/pull/55555

View File

@@ -0,0 +1,6 @@
Change: Initial release of basic version
Just prepared an initial basic version which simply embeds the minimum of
required services in the context of the ownCloud Infinite Scale project.
https://github.com/owncloud/reva-hyper/issues/2