docs: Add changelogs and release notes
These were only previously available under git tags but it's useful to have them included in the docs. They're generated by the included rudimentary bash script, changelog-release-notes.sh. Fixes: https://github.com/ansible-community/ara/issues/167 Change-Id: Ia82edb010de0fd4f6bc891d979b33c42726b2135
This commit is contained in:
parent
225d21d8f3
commit
41b307e341
46
doc/changelog-release-notes.sh
Executable file
46
doc/changelog-release-notes.sh
Executable file
@ -0,0 +1,46 @@
|
||||
#!/bin/bash
|
||||
# Copyright (c) 2020 The ARA Records Ansible authors
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
# Quick and dirty translation of release notes from git tags to rst format
|
||||
# $ ./changelog-release-notes.sh > source/changelog-release-notes.rst
|
||||
|
||||
function header() {
|
||||
echo "${1}"
|
||||
characters=$(expr length "${1}")
|
||||
printf '%0.s*' $(seq 1 $characters)
|
||||
echo
|
||||
echo
|
||||
}
|
||||
|
||||
function smallheader() {
|
||||
echo "${1}"
|
||||
characters=$(expr length "${1}")
|
||||
printf '%0.s#' $(seq 1 $characters)
|
||||
echo
|
||||
echo
|
||||
}
|
||||
|
||||
echo ".."
|
||||
echo " note: generated through doc/changelog-release-notes.sh"
|
||||
echo
|
||||
|
||||
header "Changelog and release notes"
|
||||
|
||||
# Order the git repository tags by date, exclude alpha, beta and rc releases,
|
||||
# then reverse it so the most recent one is at the top instead.
|
||||
for tag in $(git tag -l --sort=creatordate | egrep -v "a|b|rc" | tac); do
|
||||
tag_date=$(git log -1 --pretty='%ad' --date=format:'%Y-%m-%d' $tag)
|
||||
smallheader "${tag} (${tag_date})"
|
||||
echo "https://github.com/ansible-community/ara/releases/tag/${tag}"
|
||||
echo
|
||||
# Don't include a code-block if there's no message
|
||||
length=$(git tag -n9001 $tag | tail -n +3 | wc -l)
|
||||
if [ $length -gt 0 ]; then
|
||||
echo ".. code-block:: text"
|
||||
echo
|
||||
# Remove the header from the output and strip one whitespace from the left
|
||||
git tag -n9001 $tag | tail -n +3 | cut -c 1-
|
||||
fi
|
||||
echo
|
||||
done
|
1588
doc/source/changelog-release-notes.rst
Normal file
1588
doc/source/changelog-release-notes.rst
Normal file
File diff suppressed because it is too large
Load Diff
@ -20,3 +20,4 @@ Table of Contents
|
||||
CLI: ara and ara-manage <cli>
|
||||
Contributing to ARA <contributing>
|
||||
Frequently asked questions <faq>
|
||||
Changelog and release notes <changelog-release-notes>
|
||||
|
Loading…
x
Reference in New Issue
Block a user