From ccfc3520169bd88ed73801c50ea4fe3abd535a12 Mon Sep 17 00:00:00 2001
From: Simon Mavi Stewart <simon_stewart@apple.com>
Date: Wed, 28 Aug 2024 13:57:24 +0100
Subject: [PATCH] Write some notes on how to release

---
 RELEASE.md                      | 11 +++++++++++
 scripts/build-release-artifacts |  6 ++++++
 2 files changed, 17 insertions(+)
 create mode 100644 RELEASE.md
 create mode 100755 scripts/build-release-artifacts

diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 0000000..ae47916
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,11 @@
+# Releasing `apple_rules_lint`
+
+1. Update the `MODULE.bazel` and bump the version number to whatever the 
+   next release will be.
+2. `git tag "${TAG}"` where `${TAG}` is whatever the next release will be.
+3. `./scripts/build-release-artifacts`
+4. Create a new release on GitHub, and attach the artifacts generated by the 
+   previous step.
+5. Update the BCR with the new release
+6. ...
+7. Profit!
diff --git a/scripts/build-release-artifacts b/scripts/build-release-artifacts
new file mode 100755
index 0000000..61d2444
--- /dev/null
+++ b/scripts/build-release-artifacts
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+TAG="$1"
+git archive --format=tar --prefix=apple_rules_lint-"${TAG}"/ "${TAG}" | gzip > apple_rules_lint-"${TAG}".tar.gz