Skip to content

Commit

Permalink
chore: add release conventions document and refactor CI to run node r…
Browse files Browse the repository at this point in the history
…elease separately (#433)
  • Loading branch information
Daanvdplas authored Jan 22, 2025
1 parent 8c4c564 commit 8b2438b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
11 changes: 6 additions & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
10 changes: 10 additions & 0 deletions docs/release.md
Original file line number Diff line number Diff line change
@@ -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** |

0 comments on commit 8b2438b

Please sign in to comment.