From ac68a1f66ac50b25958e21a45483358891575853 Mon Sep 17 00:00:00 2001
From: Daan van der Plas <93204684+Daanvdplas@users.noreply.github.com>
Date: Wed, 22 Jan 2025 11:03:10 +0200
Subject: [PATCH] chore: add release conventions document and refactor CI to
 run node release separately (#433)

---
 .github/workflows/release.yml | 11 ++++++-----
 docs/release.md               | 10 ++++++++++
 2 files changed, 16 insertions(+), 5 deletions(-)
 create mode 100644 docs/release.md

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 248ac51b4..7b672f111 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -16,11 +16,11 @@ on:
         description: Build node
         default: true
       runtime:
-        description: 'Runtime to build (devnet, testnet, mainnet)'
-        default: ''
+        description: 'Runtime to build (none, devnet, testnet, mainnet)'
+        default: none
         type: choice
         options:
-          - ''
+          - none
           - devnet
           - testnet
           - mainnet
@@ -33,7 +33,7 @@ jobs:
       startsWith(github.event.release.tag_name, 'devnet') ||
       startsWith(github.event.release.tag_name, 'mainnet') ||
       github.event_name == 'workflow_dispatch' &&
-      github.event.inputs.runtime != ''
+      github.event.inputs.runtime != 'none'
     permissions:
       contents: write
     steps:
@@ -151,7 +151,8 @@ jobs:
 
   build-node:
     runs-on: ${{ matrix.platform.os }}
-    if: github.event_name != 'workflow_dispatch' && 'true' || inputs.node
+    if: |
+      startsWith(github.event.release.tag_name, 'node') || (github.event_name == 'workflow_dispatch' && inputs.node)
     permissions:
       contents: write
     strategy:
diff --git a/docs/release.md b/docs/release.md
new file mode 100644
index 000000000..a78799f54
--- /dev/null
+++ b/docs/release.md
@@ -0,0 +1,10 @@
+# Release Tag and Title Structure
+
+This table outlines the naming conventions for Node and Runtimes releases, including both the tag format and suggested title format.
+
+| **Release Type**            | **Tag Format**      | **Example Tag**     | **Title Format**           | **Example Title**          |
+|-----------------------------|---------------------|---------------------|----------------------------|----------------------------|
+| Node           | `node-x.y.z`    | `node-0.1.0`     | `Node v<x.y.z>`             | Node v0.1.0                  |
+| Devnet - Runtime  | `devnet-x.y.z`     | `devnet-0.1.0`      | `Devnet Runtime v<x.y.z>`  | **Devnet Runtime v0.1.0**  |
+| Testnet - Runtime | `testnet-x.y.z`    | `testnet-0.2.0`     | `Testnet Runtime v<x.y.z>` | **Testnet Runtime v0.2.0** |
+| Mainnet - Runtime | `mainnet-x.y.z`    | `mainnet-1.0.0`     | `Mainnet Runtime v<x.y.z>` | **Mainnet Runtime v1.0.0** |