URL: https://github.com/SSSD/sssd/pull/5257 Author: pbrezina Title: #5257: git-template: add tags to help with release notes automation Action: synchronized
To pull the PR as Git branch: git remote add ghsssd https://github.com/SSSD/sssd git fetch ghsssd pull/5257/head:pr5257 git checkout pr5257
From cf01f5e09c8af7e34ec96e21e7b842fe43570399 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pavel=20B=C5=99ezina?= <pbrez...@redhat.com> Date: Wed, 29 Jul 2020 12:44:26 +0200 Subject: [PATCH] git-template: add tags to help with release notes automation This commit add information on several tags that should be used so we are able to generate release notes on each new release automatically. This will make release notes more thorough and it will also simplify the process a lot since it take lots of time to do it manually. Why I chose `:tag:` format: 1. Using @ notation creates user references in github so I wanted to use something different. This notation is used in ReST documentation language so it is commonly known. 2. Using a plain text like (Resolves) leads people to create their own variations (Fixes, Resolves XYZ, ...) which adds additional burden to maintainers. Using this format makes it less error prone and easier to parse. --- .git-commit-template | 48 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 46 insertions(+), 2 deletions(-) diff --git a/.git-commit-template b/.git-commit-template index ff5b2917c2..a55ece7a01 100644 --- a/.git-commit-template +++ b/.git-commit-template @@ -2,8 +2,52 @@ COMPONENT: Subject Explanation -Resolves: -https://github.com/SSSD/sssd/issues/XXXX +Resolves: https://github.com/SSSD/sssd/issues/XXXX + +# If a release note is required, choose one of the tags and place it here. +# See the description bellow for more tags and information. This is fully +# optional: not all changes require a release note. +# +# :relnote: Generic release note. +# :feature: New feature desription. +# :fixes: Notable bug fix desription. +# :packaging: Packaging change description. +# :config: Change in configuration (new option, new default, etc.) # Try to keep the subject line within 52 chars ----| # Also please try to not exceed 72 characters of length for the body --| +# +# *** Release notes *** +# +# Release notes for new versions are automatically generated from the +# information provided in commit messages. +# +# Ticket Resolution: +# If "Resolves: ticket_url" is found in the commit message then this ticket +# will be automatically closed when this commit is pushed to the upstream +# repository. The ticket will be also mentioned in the release notes as fixed. +# +# Ideally, each commit should resolve at most one ticket. If multiple tickets +# are resolved then repeat the whole line, i.e.: +# Resolves: Ticket #1 +# Resolves: Ticket #2 +# +# Release Notes Content +# You can also provide short description of the fix or new feature for +# the release notes using one of the release notes tag. The tag is associated +# with a human readable description which is automatically put into the +# release notes into the correct group that is determined by the tag name. +# +# The description is read until an empty line is found. And it can contain +# markdown language for enhanced formatting. +# +# Example: +# SUBJECT +# +# Commit description. +# +# Resolves: https://github.com/SSSD/sssd/issues/XXXX +# +# :fixes: This is an important bug that has been fixed. Keep the description +# short but it can also span multiple lines. +#
_______________________________________________ sssd-devel mailing list -- sssd-devel@lists.fedorahosted.org To unsubscribe send an email to sssd-devel-le...@lists.fedorahosted.org Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedorahosted.org/archives/list/sssd-devel@lists.fedorahosted.org
