Package: cz-kpn
KPN'S COMMITIZENAboutPlugin forpython's commitizen,
which uses KPN commit rules to bump versions, update files and generate changelogs.KPN Rules summarySchema<PREFIX><SUBJECT>(#<ISSUE_ID>)<LONG_DESCRIPTION>PrefixSemVer relationDescriptionFIXPATCHBackwards compatible change that fixes somethingOPTPATCHOther changes like refactors, docs, which are backwards compatibleNEWMINORNew functionalityBREAKMAJORBreaking changesExampleNEW: Add login screen (#MY-123)MORE INFOInstallationInstall globally in your systempython-mpipinstall--usercz-kpnOr addcz-kpnto your project:poetryaddcz-kpn--groupdevQuickstartInitialize cz-kpn in your projectAnswer the questions appearing in:czinitBumping and changelogJust run:czbumpCommitingczcommitor the shortcutczcFeaturesClient tool to assist in the creation of a commit]note: gif is outdatedThis command is useful for newcomers, or when you don't remember the meaning
of each change type.
It will display a prompt which will guide the user in the commit creation.czcommitgitczcommitAutomatic version bumpAutomatic version bump with changelog generation.czbump--changelogNote: The--changelogflag is not required ifupdate_changelog_on_bump = trueAutomatic changelog generationIf you don't want to generate a tag and bump the version, run:czchangelogThis will create a changelog with unreleased commits, alternatively, you can runczchangelog--incrementalto add only the missing changes.
This is useful if you have manually modified your changelog.Validate commit messageThis command will tell you if there are any valid or invalid commit messages in
the given range.You can also add it to.pre-commithooks or manually as a git hook.More info incommitizen website.czcheck--rev-rangeugnu348hg84hg84g..j8fj84g84h84hg83h2392Adding commit link to the changelogAdd to the configuration thecommit_urlparameter, using$COMMIT_REVas
variable, you can take a look at this project's.cz.tomlas an example[tool.commitizen]...commit_url="https://YOUR_DOMAIN/projects/YOUR_GROUP/repos/YOUR_PROJECT/commits/$COMMIT_REV"ConfigurationThe recommendation is to runcz initwhich will help you create the
right configuration and file.You can also add manually to yourpyproject.tomlor create a.cz.tomlfile with:[tool.commitizen]name="cz_kpn"version="<YOUR_CURRENT_VERSION>"version_files=["src/__version__.py"]slack_channel="ddci-notifications"Helpcz--helpContents:$cz--help
Commitizenisaclitooltogenerateconventionalcommits.
Formoreinformationaboutthetopicgotohttps://conventionalcommits.org/

options:-h,--helpshowthishelpmessageandexit--debugusedebugmode-nNAME,--nameNAMEusethegivencommitizen(default:cz_conventional_commits)-nrNO_RAISE,--no-raiseNO_RAISEcommaseparatederrorcodesthatwon'triseerror,e.g:cz-nr1,2,3bump.Seecodesathttps://commitizen-tools.github.io/commitizen/exit_codes/

commands:{init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}initinitcommitizenconfigurationcommit(c)createnewcommitlsshowavailablecommitizensexampleshowcommitexampleinfoshowinformationabouttheczschemashowcommitschemabumpbumpsemanticversionbasedonthegitlogchangelog(ch)generatechangelog(notethatitwilloverwriteexistingfile)checkvalidatesthatacommitmessagematchesthecommitizenschemaversiongettheversionoftheinstalledcommitizenorthecurrentproject(default:installedcommitizen)ContributingReadContributing guideUsing in a github actionname:Bump version and generate changelogon:push:branches:-mainjobs:bump-version:if:"!startsWith(github.event.head_commit.message,'BUMP:')"runs-on:ubuntu-latestname:"Bumpversionandcreatechangelogwithcommitizen"steps:-name:Check outuses:actions/checkout@v3with:fetch-depth:0token:${{ secrets.PERSONAL_ACCESS_TOKEN }}-name:Create bump and changeloguses:commitizen-tools/commitizen-action@masterwith:github_token:${{ secrets.PERSONAL_ACCESS_TOKEN }}changelog_increment_filename:body.mdextra_requirements:'cz-kpn'-name:Releaseuses:softprops/action-gh-release@v1with:body_path:"body.md"tag_name:${{ env.REVISION }}env:GITHUB_TOKEN:${{ secrets.GITHUB_TOKEN }}Read more incommitizen docs