From c9bbfa1272db992d19939f22631a5fa6dc659175 Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Fri, 25 Sep 2020 01:32:03 +0200 Subject: [PATCH] chore: Added configuration files for generating the changelog of a release. --- script/gcg/readme.md | 31 +++++++++++++++++++++ script/gcg/traefik-bugfix.toml | 27 ++++++++++++++++++ script/gcg/traefik-final-release-part1.toml | 27 ++++++++++++++++++ script/gcg/traefik-final-release-part2.toml | 27 ++++++++++++++++++ script/gcg/traefik-rc-first.toml | 27 ++++++++++++++++++ script/gcg/traefik-rc-new.toml | 27 ++++++++++++++++++ 6 files changed, 166 insertions(+) create mode 100644 script/gcg/readme.md create mode 100644 script/gcg/traefik-bugfix.toml create mode 100644 script/gcg/traefik-final-release-part1.toml create mode 100644 script/gcg/traefik-final-release-part2.toml create mode 100644 script/gcg/traefik-rc-first.toml create mode 100644 script/gcg/traefik-rc-new.toml diff --git a/script/gcg/readme.md b/script/gcg/readme.md new file mode 100644 index 000000000..393786e05 --- /dev/null +++ b/script/gcg/readme.md @@ -0,0 +1,31 @@ +# GCG - GitHub Changelog Generator + +Installation: https://github.com/ldez/gcg#how-to-install + +## Generates Changelog for a Bug Fix Release + +```bash +gcg --config-file=./script/gcg/traefik-bugfix.toml +``` + +## Generates Changelog for a Final Release + +```bash +gcg --config-file=./script/gcg/traefik-final-release-part1.toml +``` + +```bash +gcg --config-file=./script/gcg/traefik-final-release-part2.toml +``` + +## Generates Changelog for the first RC of a Version + +```bash +gcg --config-file=./script/gcg/traefik-rc-first.toml +``` + +## Generates Changelog for a RC of a Version + +```bash +gcg --config-file=./script/gcg/traefik-rc-new.toml +``` diff --git a/script/gcg/traefik-bugfix.toml b/script/gcg/traefik-bugfix.toml new file mode 100644 index 000000000..12a46dbef --- /dev/null +++ b/script/gcg/traefik-bugfix.toml @@ -0,0 +1,27 @@ +Owner = "traefik" +RepositoryName = "traefik" + +OutputType = "file" +FileName = "traefik_changelog.md" + +# example new bugfix v2.3.1 +CurrentRef = "v2.3" +PreviousRef = "v2.3.0" +BaseBranch = "v2.3" +FutureCurrentRefName = "v2.3.1" + +ThresholdPreviousRef = 10 +ThresholdCurrentRef = 10 + +Debug = true +DisplayLabel = true + +LabelExcludes = ["area/infrastructure"] +LabelEnhancement = "kind/enhancement" +LabelDocumentation = "area/documentation" +LabelBug = "kind/bug/fix" + +[DisplayLabelOptions] + FilteredPrefixes = ["area/", "platform/"] + ExcludedSuffixes = ["documentation"] + TrimmedPrefixes = ["area/provider/", "area/middleware/", "area/", "platform/"] diff --git a/script/gcg/traefik-final-release-part1.toml b/script/gcg/traefik-final-release-part1.toml new file mode 100644 index 000000000..7ef7b1fe0 --- /dev/null +++ b/script/gcg/traefik-final-release-part1.toml @@ -0,0 +1,27 @@ +Owner = "traefik" +RepositoryName = "traefik" + +OutputType = "file" +FileName = "traefik_changelog.md" + +# example final release of v2.3.0 +CurrentRef = "v2.3" +PreviousRef = "v2.3.0-rc7" +BaseBranch = "v2.3" +FutureCurrentRefName = "v2.3.0" + +ThresholdPreviousRef = 10 +ThresholdCurrentRef = 10 + +Debug = true +DisplayLabel = true + +LabelExcludes = ["area/infrastructure"] +LabelEnhancement = "kind/enhancement" +LabelDocumentation = "area/documentation" +LabelBug = "kind/bug/fix" + +[DisplayLabelOptions] + FilteredPrefixes = ["area/", "platform/"] + ExcludedSuffixes = ["documentation"] + TrimmedPrefixes = ["area/provider/", "area/middleware/", "area/", "platform/"] diff --git a/script/gcg/traefik-final-release-part2.toml b/script/gcg/traefik-final-release-part2.toml new file mode 100644 index 000000000..6fd821820 --- /dev/null +++ b/script/gcg/traefik-final-release-part2.toml @@ -0,0 +1,27 @@ +Owner = "traefik" +RepositoryName = "traefik" + +OutputType = "file" +FileName = "traefik_changelog.md" + +# example final release of v2.3.0 +CurrentRef = "v2.3.0-rc1" +PreviousRef = "v2.2.0-rc1" +BaseBranch = "master" +FutureCurrentRefName = "v2.3.0-rc1" + +ThresholdPreviousRef = 10 +ThresholdCurrentRef = 10 + +Debug = true +DisplayLabel = true + +LabelExcludes = ["area/infrastructure"] +LabelEnhancement = "kind/enhancement" +LabelDocumentation = "area/documentation" +LabelBug = "kind/bug/fix" + +[DisplayLabelOptions] + FilteredPrefixes = ["area/", "platform/"] + ExcludedSuffixes = ["documentation"] + TrimmedPrefixes = ["area/provider/", "area/middleware/", "area/", "platform/"] diff --git a/script/gcg/traefik-rc-first.toml b/script/gcg/traefik-rc-first.toml new file mode 100644 index 000000000..39435bdda --- /dev/null +++ b/script/gcg/traefik-rc-first.toml @@ -0,0 +1,27 @@ +Owner = "traefik" +RepositoryName = "traefik" + +OutputType = "file" +FileName = "traefik_changelog.md" + +# example RC1 of v2.3.0 +CurrentRef = "master" +PreviousRef = "v2.2.0-rc1" +BaseBranch = "master" +FutureCurrentRefName = "v2.3.0-rc1" + +ThresholdPreviousRef = 10 +ThresholdCurrentRef = 10 + +Debug = true +DisplayLabel = true + +LabelExcludes = ["area/infrastructure"] +LabelEnhancement = "kind/enhancement" +LabelDocumentation = "area/documentation" +LabelBug = "kind/bug/fix" + +[DisplayLabelOptions] + FilteredPrefixes = ["area/", "platform/"] + ExcludedSuffixes = ["documentation"] + TrimmedPrefixes = ["area/provider/", "area/middleware/", "area/", "platform/"] diff --git a/script/gcg/traefik-rc-new.toml b/script/gcg/traefik-rc-new.toml new file mode 100644 index 000000000..f66b0fe89 --- /dev/null +++ b/script/gcg/traefik-rc-new.toml @@ -0,0 +1,27 @@ +Owner = "traefik" +RepositoryName = "traefik" + +OutputType = "file" +FileName = "traefik_changelog.md" + +# example RC2 of v2.3.0 +CurrentRef = "v2.3" +PreviousRef = "v2.3.0-rc1" +BaseBranch = "v2.3" +FutureCurrentRefName = "v2.3.0-rc2" + +ThresholdPreviousRef = 10 +ThresholdCurrentRef = 10 + +Debug = true +DisplayLabel = true + +LabelExcludes = ["area/infrastructure"] +LabelEnhancement = "kind/enhancement" +LabelDocumentation = "area/documentation" +LabelBug = "kind/bug/fix" + +[DisplayLabelOptions] + FilteredPrefixes = ["area/", "platform/"] + ExcludedSuffixes = ["documentation"] + TrimmedPrefixes = ["area/provider/", "area/middleware/", "area/", "platform/"]