New process for CHANGELOG entries

.github/pull_request_template.md

@@ -4,8 +4,8 @@
  - [ ] The **PR description** provides context as to why the change should occur and what the code contributes to that effect. This could also be a link to a JIRA ticket or a Github issue, if there is one.
  - [ ] If end-points have been added or changed: the **endpoint / config-flag checklist** (see Wire-employee only backend [wiki page](https://github.com/zinfra/backend-wiki/wiki/Checklists)) has been followed.
  - [ ] If a schema migration has been added, I ran **`make git-add-cassandra-schema`** to update the cassandra schema documentation.
- - [ ] Section *Unreleased* of **CHANGELOG-draft.md** contains the following bits of information:
-   - [ ] A line with the title and number of the PR in one or more suitable sub-sections.
+ - [ ] **changelog.d** contains the following bits of information:
+   - [ ] A file with the changelog entry in one or more suitable sub-sections. The sub-sections are marked by directories inside `changelog.d`.
    - [ ] If /a: measures to be taken by instance operators.
    - [ ] If /a: list of cassandra migrations.
    - [ ] If public end-points have been changed or added: does nginz need upgrade?

changelog.d/0-release-notes/.title

@@ -0,0 +1 @@
+Release notes

changelog.d/1-api-changes/.title

@@ -0,0 +1 @@
+API changes

changelog.d/1-api-changes/pr-1726

@@ -0,0 +1 @@
+Remove the long-deprecated `message` field in `POST /connections` (#1726)

changelog.d/1-api-changes/pr-1737-1

@@ -0,0 +1 @@
+Add `PUT /conversations/:domain/:cnv/name` (#1737)

changelog.d/1-api-changes/pr-1737-2

@@ -0,0 +1 @@
+Deprecate `PUT /conversations/:cnv/name` (#1737)

changelog.d/1-api-changes/pr-1740-1

@@ -0,0 +1 @@
+Add `GET & PUT /conversations/:domain/:cnv/self` (#1740)

changelog.d/1-api-changes/pr-1740-2

@@ -0,0 +1 @@
+Deprecate `GET & PUT /conversations/:cnv/self` (#1740)

changelog.d/2-features/.title

@@ -0,0 +1 @@
+Features

changelog.d/3-bug-fixes/.title

@@ -0,0 +1 @@
+Bug fixes and other updates

changelog.d/4-docs/.title

@@ -0,0 +1 @@
+Documentation

changelog.d/4-docs/pr-1674

@@ -0,0 +1 @@
+Added documentation of federation errors (#1674)

changelog.d/4-docs/pr-1748-1

@@ -0,0 +1 @@
+Better swagger schema for the Range type (#1748)

changelog.d/4-docs/pr-1748-2

@@ -0,0 +1 @@
+Add better example for Domain in swagger (#1748)

changelog.d/5-internal/.title

@@ -0,0 +1 @@
+Internal changes

changelog.d/5-internal/changelog-migration

@@ -0,0 +1 @@
+Introduce new process for writing changelogs

changelog.d/5-internal/pr-1726

@@ -0,0 +1 @@
+Rewrite the `POST /connections` endpoint to Servant (#1726)

changelog.d/6-federation/.title

@@ -0,0 +1 @@
+Federation changes

changelog.d/6-federation/pr-1713

@@ -0,0 +1 @@
+Avoid remote calls to get conversation when it is not found locally

changelog.d/6-federation/pr-1730

@@ -0,0 +1 @@
+Federator CA store and client credentials are now automatically reloaded (#1730)

changelog.d/6-federation/pr-1739

@@ -0,0 +1 @@
+Ensure clients only receive messages meant for them in remote convs (#1739)

changelog.d/mk-changelog.sh

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+shopt -s nullglob
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+getPRNumber() {
+    git log --reverse --format=%s -- $1 | sed -rn '1 { /\((#.*)\)$/ s|^.*\((#.*)\)$|\1|p; }' | grep "" ||
+      echo "#PR_NOT_FOUND"
+}
+
+for d in "$DIR"/*; do
+    if [[ ! -d "$d" ]]; then continue; fi
+
+    echo -n "## "
+    sed '$ a\' "$d/.title"
+    echo ""
+    for f in "$d"/*; do
+        pr=$(getPRNumber $f)
+        sed -r '
+          # create a bullet point on the first line
+          1 { s/^/\* /; }
+
+          # indent subsequent lines
+          1 !{ s/^/  /; }
+
+          # replace ## with PR number throughout
+          s/##/'"$pr"'/g
+
+          # add PR number at the end (unless already present)
+          $ { /^.*\((#.*)\)$/ ! { s/$/ ('"$pr"')/; } }
+
+          # remove trailing whitespace
+          s/\s+$//
+
+          # make sure there is a trailing newline
+          $ a\' "$f"
+    done
+    echo ""
+done