From 01017e22baf4f5601373548c183ecea7d29228b6 Mon Sep 17 00:00:00 2001 From: Thomas Boerger Date: Wed, 4 Sep 2019 16:38:17 +0200 Subject: [PATCH] Add chngelog generator basics --- changelog/CHANGELOG.tmpl | 28 +++++++++++++++++++++++++ changelog/README.md | 7 +++++++ changelog/TEMPLATE | 11 ++++++++++ changelog/unreleased/initial-release.md | 7 +++++++ 4 files changed, 53 insertions(+) create mode 100644 changelog/CHANGELOG.tmpl create mode 100644 changelog/README.md create mode 100644 changelog/TEMPLATE create mode 100644 changelog/unreleased/initial-release.md diff --git a/changelog/CHANGELOG.tmpl b/changelog/CHANGELOG.tmpl new file mode 100644 index 0000000000..3fee894812 --- /dev/null +++ b/changelog/CHANGELOG.tmpl @@ -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 -}} diff --git a/changelog/README.md b/changelog/README.md new file mode 100644 index 0000000000..fd2b505412 --- /dev/null +++ b/changelog/README.md @@ -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. diff --git a/changelog/TEMPLATE b/changelog/TEMPLATE new file mode 100644 index 0000000000..633c30a4b5 --- /dev/null +++ b/changelog/TEMPLATE @@ -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-phoenix/issues/1234 +https://github.com/owncloud/reva-phoenix/pull/55555 diff --git a/changelog/unreleased/initial-release.md b/changelog/unreleased/initial-release.md new file mode 100644 index 0000000000..8b45e1370d --- /dev/null +++ b/changelog/unreleased/initial-release.md @@ -0,0 +1,7 @@ +Change: Initial release of basic version + +Just prepared an initial basic version to serve Phoenix for the ownCloud +Infinite Scale project. It just provides a minimal viable product to +demonstrate the microservice pattern. + +https://github.com/owncloud/reva-phoenix/issues/3