feat: Documenting release workflow.

This commit is contained in:
2024-12-19 10:24:10 -05:00
parent d1de0e1996
commit 9ec86bc523

15
Release.md Normal file
View File

@@ -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.