chore: Added configuration files for generating the changelog of a release.
This commit is contained in:
parent
8ca0d804d8
commit
c9bbfa1272
6 changed files with 166 additions and 0 deletions
31
script/gcg/readme.md
Normal file
31
script/gcg/readme.md
Normal file
|
@ -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
|
||||
```
|
27
script/gcg/traefik-bugfix.toml
Normal file
27
script/gcg/traefik-bugfix.toml
Normal file
|
@ -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/"]
|
27
script/gcg/traefik-final-release-part1.toml
Normal file
27
script/gcg/traefik-final-release-part1.toml
Normal file
|
@ -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/"]
|
27
script/gcg/traefik-final-release-part2.toml
Normal file
27
script/gcg/traefik-final-release-part2.toml
Normal file
|
@ -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/"]
|
27
script/gcg/traefik-rc-first.toml
Normal file
27
script/gcg/traefik-rc-first.toml
Normal file
|
@ -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/"]
|
27
script/gcg/traefik-rc-new.toml
Normal file
27
script/gcg/traefik-rc-new.toml
Normal file
|
@ -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/"]
|
Loading…
Reference in a new issue