Release process: changelog generation and docs (#3446)

* Remove extra pyprojects and update changelog docs

* Add script for rendering the changelog

* Add docs for how to release the spec

* Move legacy changelogs out of the way
This commit is contained in:
Travis Ralston 2021-10-18 10:09:35 -06:00 committed by GitHub
parent 61ac438871
commit e8674688e6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
22 changed files with 172 additions and 282 deletions

View file

@ -0,0 +1,35 @@
# /bin/bash
# Usage: ./generate.sh v1.2 "April 01, 2021"
set -e
MAGIC_STRING="<!-- DO NOT REMOVE OR CHANGE - Release script puts next release here -->"
cd changelogs
# Pre-cleanup just in case it wasn't done on the last run
rm -f rendered.*
# Reversed order so the push gateway ends up on the bottom
towncrier --name "Push Gateway API" --dir "./push_gateway" --config "./pyproject.toml" --yes
towncrier --name "Identity Service API" --dir "./identity_service" --config "./pyproject.toml" --yes
towncrier --name "Application Service API" --dir "./application_service" --config "./pyproject.toml" --yes
towncrier --name "Server-Server API" --dir "./server_server" --config "./pyproject.toml" --yes
towncrier --name "Client-Server API" --dir "./client_server" --config "./pyproject.toml" --yes
# Prepare the header
cp header.md rendered.header.md
sed -i "s/VERSION/$1/g" rendered.header.md
sed -i "s/DATE/$2/g" rendered.header.md
cat rendered.header.md rendered.md > rendered.final.md
# Remove trailing whitespace (such as our intentionally blank RST headings)
sed -i "s/[ ]*$//" rendered.final.md
# Put the changelog in place
mv rendered.final.md ../layouts/partials/changelogs/$1.md
sed -i "s/$MAGIC_STRING/$MAGIC_STRING\n{{% changelog\\/changelog-rendered p=\"changelogs\\/$1.md\" %}}/" ../content/changelog.md
# Cleanup
rm -v rendered.*

View file

@ -7,4 +7,4 @@ jsonschema >= 2.6.0, < 3.0.0
PyYAML >= 3.12
requests >= 2.18.4
towncrier == 18.6.0
towncrier == 21.9.0rc1