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 6d2cbf04c026b7fb7f9da362dac52b86da0e808c 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 commits 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. 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 | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/.git-commit-template b/.git-commit-template index ff5b2917c2..ea04bcb1a4 100644 --- a/.git-commit-template +++ b/.git-commit-template @@ -5,5 +5,38 @@ Explanation 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. +:relnote: Generic release note. +:feature: New feature desription. +:bug: Notable bug desription. + # 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. Please keep the formatting of +# resolved tickets exact (Resolves:/NEWLINE/ticket_url). You can specify +# multiple tickets, one ticket per line. +# +# You can also provide short description of the fix or new feature for +# the release notes using the following tags: +# +# :relnote: Generic release note. +# :feature: New feature desription. +# :bug: Notable bug desription. +# :packaging: Packaging change description. +# +# :newoption: option_name, manpage_name +# :deloption: removed_option_name +# :newdefault: option_name, old_value, new_value +# +# The description is read until an empty line is found. Please, keep formatting +# of the option tags exact. You can use markdown language in the description. +# +# Example: +# :bug: 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
