From 73da36f4055b18aed667e4efce5a736fc2ff1c42 Mon Sep 17 00:00:00 2001 From: jkoberg Date: Fri, 8 Oct 2021 09:26:43 +0200 Subject: [PATCH] add type docu to changelog template --- changelog/README.md | 10 ++++++++++ changelog/TEMPLATE | 4 ++++ changelog/unreleased/reva-gateway-configuration.md | 3 ++- 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/changelog/README.md b/changelog/README.md index 0ae5d5b3e2d..ad2a2fbdecf 100644 --- a/changelog/README.md +++ b/changelog/README.md @@ -4,3 +4,13 @@ We are using [calens](https://github.com/restic/calens) to properly generate a changelog before we are tagging a new release. To get an idea how this could look like would be the best reference. + +## Create changelog items + +Create a file according to the template for each changelog in the unreleased folder. +The following change types are possible: +- Bugfix (general Bugfix) +- Enhancement (new feature) +- Change (breaking change) +- Security (security related issues) + diff --git a/changelog/TEMPLATE b/changelog/TEMPLATE index 4cb31e865bd..d2ba47a319d 100644 --- a/changelog/TEMPLATE +++ b/changelog/TEMPLATE @@ -9,3 +9,7 @@ in case there aren't any issue links) is used as the primary ID. https://github.com/owncloud/ocis/pull/55555 https://github.com/owncloud/ocis/issues/1234 + +Note: Possible keywords are Bugfixes (for bug fixes), Enhancement (for new features), +Change (for breaking changes), Security (for security related topics) + diff --git a/changelog/unreleased/reva-gateway-configuration.md b/changelog/unreleased/reva-gateway-configuration.md index 5ef7cebbe83..7f124f243a9 100644 --- a/changelog/unreleased/reva-gateway-configuration.md +++ b/changelog/unreleased/reva-gateway-configuration.md @@ -1,7 +1,8 @@ -Enhancement: Unify Envvar names configuring REVA gateway address +Change: Unify Envvar names configuring REVA gateway address We've renamed all envvars configuring REVA gateway address to `REVA_GATEWAY`, additionally we renamed the cli parameters to `--reva-gateway-addr` and adjusted the description https://github.com/owncloud/ocis/pull/2587 https://github.com/owncloud/ocis/issues/2091 +