From 86dc084e7db64bf035f2c836a2d82eecaf4e3c43 Mon Sep 17 00:00:00 2001
From: Michael Housh <mhoush@houshhomeenergy.com>
Date: Thu, 19 Dec 2024 10:24:10 -0500
Subject: [PATCH] feat: Documenting release workflow.

---
 Release.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 Release.md

diff --git a/Release.md b/Release.md
new file mode 100644
index 0000000..333cff8
--- /dev/null
+++ b/Release.md
@@ -0,0 +1,15 @@
+# Release Workflow Steps
+
+This is a reminder of the steps used to create a release and update the homebrew formula.
+
+1. Push a tagged branch, this will initiate the release being created.
+   1. Don't forget to also update the version in `Sources/hpa/Version.swift`, prior.
+1. Get the `sha` of the `*.tar.gz` in the release.
+   1. `just get-release-sha`
+1. Update the homebrew formula url, sha256, and version at top of the homebrew formula.
+   1. `cd $(brew --repo michael/formula)`
+1. Build and generate a homebrew bottle.
+   1. `just bottle`
+1. Update the `bottle do` section of homebrew formula with output during previous step.
+1. Upload the bottle `*.tar.gz` file that was created to the release.
+1. Generate a pull-request to the formula repo.