From 71a1d78e394cfb37c7fbe75025e1c7668f228a0b Mon Sep 17 00:00:00 2001 From: Songmu Date: Sat, 20 Aug 2022 21:19:05 +0900 Subject: [PATCH] update config base --- config.go | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/config.go b/config.go index f6f132c..c6c2ab4 100644 --- a/config.go +++ b/config.go @@ -6,7 +6,19 @@ import ( const ( defaultConfigFile = ".rcpr" - defaultConfigContent = `# config file for rcpr in git config format + defaultConfigContent = `# config file for the rcpr in git config format +# The rcpr generates the initial configuration, which you can rewrite to suit your environment. +# CONFIGURATIONS: +# rcpr.releaseBranch +# Generally, it is "main." It is the branch for releases. The pcpr tracks this branch, +# creates or updates a pull request as a release candidate, or tags when they are merged. +# +# rcpr.versinFile +# A versioning file containing the semantic version needed to be updated at release. +# It will be synchronized with the "git tag". +# Often this is a meta-information file such as gemspec, setup.cfg, package.json, etc. +# Sometimes the source code file, such as version.go or Bar.pm, is used. +# If you do not want to use versioning files but only git tags, specify the "-" string here. [rcpr] ` envReleaseBranch = "RCPR_RELEASE_BRANCH"