How to update build images

1 files changed, 17 insertions, 0 deletions

diff --git a/builds.sr.ht/updates.md b/builds.sr.ht/updates.md
new file mode 100644
index 0000000..0338d84
--- /dev/null
+++ b/builds.sr.ht/updates.md
@@ -0,0 +1,17 @@
+---
+toc: false
+---
+
+# How to update a build image
+
+1. Prepare the necessary patch. Should include:
+   - Updates to the images/ directory, including adding the new version,
+     removing any obsolete versions, and updating any symlinks
+   - Updating contrib/crontab
+2. Prepare a patch for sr.ht-docs:builds.sr.ht/compatibility.md
+3. Submit a test build based on your image's build.yml which proves that your
+   change works
+
+Then send these patches upstream to sr.ht-dev. Include a link to the successful
+image build and instructions on how to deploy it (usually this is as simple as
+submitting the build.yml with the appropriate version number put in).