From b6a1c60fbd786b7ec97960ac286008c5cd76a437 Mon Sep 17 00:00:00 2001
From: recanman <29310982+recanman@users.noreply.github.com>
Date: Fri, 24 May 2024 19:42:46 -0700
Subject: [PATCH] ci: release workflow and documentation

---
 .github/workflows/release.yml |  2 +-
 PUBLISHING.md                 | 23 +++++++++++++++++++++++
 2 files changed, 24 insertions(+), 1 deletion(-)
 create mode 100644 PUBLISHING.md

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 1d5a6d3..3b3fde4 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -34,5 +34,5 @@ jobs:
         uses: stefanzweifel/git-auto-commit-action@v4
         with:
           branch: main
-          commit_message: 'docs: update CHANGELOG.md for ${{ github.ref_name }} [skip ci]'
+          commit_message: 'chore(release): v${{ github.ref_name }} [skip ci]'
           file_pattern: CHANGELOG.md
\ No newline at end of file
diff --git a/PUBLISHING.md b/PUBLISHING.md
new file mode 100644
index 0000000..7dca229
--- /dev/null
+++ b/PUBLISHING.md
@@ -0,0 +1,23 @@
+# Publishing a release
+
+This document describes the process of publishing a new version of the package.
+
+1. Update the version in the `composer.json` file.
+2. Commit the changes.
+	-	```bash
+		git commit -m "chore: bump version to <version>"
+		```
+
+		Where `<version>` is the new version number (e.g. `1.2.3`).
+3. Create a new tag.
+	-	```bash
+		git tag v<version>
+		```
+
+		Where `<version>` is the new version number (e.g. `1.2.3`).
+4. Push the changes.
+	-	```bash
+		git push origin master --tags
+		```
+
+A release will automatically be created.
\ No newline at end of file