From efab2097150a175505011ba9f77943c96063341c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9gis=20Behmo?= <regis@behmo.com>
Date: Fri, 19 May 2023 16:19:56 +0200
Subject: [PATCH] docs: add a scriv-managed changelog

This will be useful for tracking changes across releases.

This partly addresses https://github.com/overhangio/tutor/issues/746
---
 CHANGELOG.md                         | 21 +++++++++++++++++++++
 changelog.d/20230519_161836_regis.md |  1 +
 changelog.d/scriv.ini                | 18 ++++++++++++++++++
 3 files changed, 40 insertions(+)
 create mode 100644 CHANGELOG.md
 create mode 100644 changelog.d/20230519_161836_regis.md
 create mode 100644 changelog.d/scriv.ini

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..3ffc77f
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,21 @@
+i# Changelog
+
+This file includes a history of past releases. Changes that were not yet added to a release are in the [changelog.d/](./changelog.d) folder.
+
+<!--
+⚠️ DO NOT ADD YOUR CHANGES TO THIS FILE! (unless you want to modify existing changelog entries in this file)
+Changelog entries are managed by scriv. After you have made some changes to this plugin, create a changelog entry with:
+
+    scriv create
+
+Edit and commit the newly-created file in changelog.d.
+
+If you need to create a new release, create a separate commit just for that. It is important to respect these
+instructions, because git commits are used to generate release notes:
+  - Modify the version number in `__about__.py`.
+  - Collect changelog entries with `scriv collect`
+  - The title of the commit should be the same as the new version: "vX.Y.Z".
+-->
+
+<!-- scriv-insert-here -->
+
diff --git a/changelog.d/20230519_161836_regis.md b/changelog.d/20230519_161836_regis.md
new file mode 100644
index 0000000..7d796ae
--- /dev/null
+++ b/changelog.d/20230519_161836_regis.md
@@ -0,0 +1 @@
+- [Improvement] Add a scriv-compliant changelog. (by @regisb)
diff --git a/changelog.d/scriv.ini b/changelog.d/scriv.ini
new file mode 100644
index 0000000..36cd157
--- /dev/null
+++ b/changelog.d/scriv.ini
@@ -0,0 +1,18 @@
+[scriv]
+version = literal: tutorxqueue/__about__.py: __version__
+categories =
+format = md
+md_header_level = 2
+new_fragment_template =
+    <!--
+    Create a changelog entry for every new user-facing change. Please respect the following instructions:
+    - Indicate breaking changes by prepending an explosion 💥 character.
+    - Prefix your changes with either [Bugfix], [Improvement], [Feature], [Security], [Deprecation].
+    - You may optionally append "(by @<author>)" at the end of the line, where "<author>" is either one (just one)
+    of your GitHub username, real name or affiliated organization. These affiliations will be displayed in
+    the release notes for every release.
+    -->
+
+    <!-- - 💥[Feature] Foobarize the blorginator. This breaks plugins by renaming the `FOO_DO` filter to `BAR_DO`. (by @regisb) -->
+    <!-- - [Improvement] This is a non-breaking change. Life is good. (by @billgates) -->
+entry_title_template = {%% if version %%}v{{ version }} {%% endif %%}({{ date.strftime('%%Y-%%m-%%d') }})