Add releases.md.

Author: ioquatix

bake.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
+
+# Update the project documentation with the new version number.
+#
+# @parameter version [String] The new version number.
+def after_gem_release_version_increment(version)
+	context["releases:update"].call(version)
+	context["utopia:project:readme:update"].call
+end

gems.rb

@@ -10,6 +10,7 @@
 group :maintenance, optional: true do
 	gem "bake-modernize"
 	gem "bake-gem"
+	gem "bake-releases"
 
 	gem "utopia-project"
 end

readme.md

@@ -2,12 +2,12 @@
 
 Sus is a testing framework for Ruby.
 
-- It's similar to RSpec but with less baggage and more parallelism.
-- It uses `expect` style syntax with first-class predicates.
-- It has direct [support for code coverage](https://github.com/socketry/covered).
-- It supports the [VSCode Test Runner interface](https://github.com/socketry/sus-vscode).
-- It's based on my experience writing thousands of tests.
-- It's easy to extend (see the `sus-fixtures-` gems for examples).
+  - It's similar to RSpec but with less baggage and more parallelism.
+  - It uses `expect` style syntax with first-class predicates.
+  - It has direct [support for code coverage](https://github.com/socketry/covered).
+  - It supports the [VSCode Test Runner interface](https://github.com/socketry/sus-vscode).
+  - It's based on my experience writing thousands of tests.
+  - It's easy to extend (see the `sus-fixtures-` gems for examples).
 
 [![Development Status](https://github.com/socketry/sus/workflows/Test/badge.svg)](https://github.com/socketry/sus/actions?workflow=Test)
 
@@ -25,9 +25,17 @@ Please see the [project documentation](https://socketry.github.io/sus/) for more
 
   - [Getting Started](https://socketry.github.io/sus/guides/getting-started/index) - This guide explains how to use the `sus` gem to write tests for your Ruby projects.
 
+## Releases
+
+Please see the [project releases](https://socketry.github.io/sus/releases/index) for all releases.
+
+### Unreleased
+
+  - `Sus::Config` now has a `prepare_warnings!` hook which enables deprecated warnings by default. This is generally considered good behaviour for a test framework.
+
 ## See Also
 
-- [sus-vscode](https://github.com/socketry/sus-vscode) - Visual Studio Code extension for Sus.
+  - [sus-vscode](https://github.com/socketry/sus-vscode) - Visual Studio Code extension for Sus.
 
 ## Contributing
 

releases.md

@@ -0,0 +1,6 @@
+# Releases
+
+## Unreleased
+
+  - `Sus::Config` now has a `prepare_warnings!` hook which enables deprecated warnings by default. This is generally considered good behaviour for a test framework.
+