public-Repo-Mirrors/Top-Bar-Organizer
1
Fork 0
mirror of https://gitlab.gnome.org/julianschacher/top-bar-organizer.git synced 2025-10-27 07:09:07 +00:00
Code Releases Activity

docs: enhance the git annotated tag and release notes templates

Browse Source 
- Give them a better general structure by having a "Relevant and/or
  Breaking Changes" and an "Other Changes" section.
- Use more minimal markup in the git annotated tag template as that
  works better for annotated tags.
- Use nicer and more useful placeholder values.
- Get rid of unnecessary descriptions.
This commit is contained in:
June 2024-09-11 03:51:31 +02:00
parent 8fb92d1bb1
commit ea3942057f
No known key found for this signature in database
2 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/release_notes_template.md
View File

@ -4,12 +4,23 @@ Top Bar Organizer vX includes the following changes:
The following relevant and/or breaking changes of this version:
<list relevant and/or breaking changes of this version here>
## Breaking Change
Description
## Relevant Change
Description
# Other Changes
- a change
- another change
# `git shortlog`
The git shortlog for this version:
```
<paste the git shortlog for this version here>
git shortlog vX-1..vX
```

12
git_annotated_tag_template
View File

@ -1,7 +1,9 @@
Top Bar Organizer vX includes the following changes:
Top Bar Organizer vX
# Relevant and/or Breaking Changes
Relevant and/or Breaking Changes:
- breaking change: description
- relevant change: description
The following relevant and/or breaking changes of this version:
<list relevant and/or breaking changes of this version here>
Other Changes:
- a change
- another change