Merge pull request #194 from plebhash/2026-01-20-publish-apps

automate publishing `sv2-apps` crates to `crates.io`

Author: GitGab19

.github/workflows/release-apps.yaml

@@ -0,0 +1,54 @@
+# This workflow is used to publish sv2-apps crates to crates.io
+# the workflow tries to publish all the sv2-apps crates by running scripts/release-apps.sh
+# in case the `cargo publish` command fails, the script returns 1 and the entire workflow fails
+# the only exception is when the `cargo publish` command fails because the crate has already
+# been published, in which case the workflow continues
+
+name: Release Apps
+
+on:
+  # Manually run by going to "Actions/Release" in Github and running the workflow
+  workflow_dispatch:
+  # every time a new release tag is created
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  release-apps:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - uses: actions/checkout@v4
+
+      - name: Install Rust (1.85)
+        uses: dtolnay/rust-toolchain@1.85
+
+      - name: Login
+        run: cargo login ${{ secrets.CRATES_IO_DEPLOY_KEY }}
+
+      - name: Publish stratum-apps crate
+        run: ./scripts/release-apps.sh stratum-apps
+
+      - name: Publish bitcoin-core-sv2 crate
+        run: ./scripts/release-apps.sh bitcoin-core-sv2
+
+      - name: Publish jd-client-sv2 crate
+        run: ./scripts/release-apps.sh miner-apps/jd-client
+
+      - name: Publish translator-sv2 crate
+        run: ./scripts/release-apps.sh miner-apps/translator
+
+      - name: Publish pool-sv2 crate
+        run: ./scripts/release-apps.sh pool-apps/pool
+
+      # todo: uncomment after https://github.com/stratum-mining/sv2-apps/issues/24
+      # - name: Publish jd-server crate
+      #   run: ./scripts/release-apps.sh jd-server
+
+      - name: Publish integration-tests-sv2 crate
+        run: ./scripts/release-apps.sh integration-tests
+
+

scripts/release-apps.sh

@@ -0,0 +1,35 @@
+#!/bin/sh
+
+# USAGE:
+#   ./scripts/release-apps.sh
+
+# the script returns 0 on success of cargo publish, and 1 on failure
+# the only exception is when cargo publish fails because the crate is already published
+# in that case, the script also returns 0
+
+CRATE_DIR="$1"
+
+echo "Publishing crate in directory: $CRATE_DIR"
+
+cd "$CRATE_DIR"
+
+CARGO_COMMAND="cargo publish"
+
+OUTPUT="$($CARGO_COMMAND 2>&1)"
+EXIT_CODE=$?
+echo "Ran cargo command, exit code was $EXIT_CODE"
+
+if [ "$EXIT_CODE" -eq 0 ] ; then
+  echo "Publish command succeeded: $CRATE_DIR"
+  exit 0
+fi
+
+# If cargo failed, check whether it was 'already uploaded'
+if echo "$OUTPUT" | grep -q "already uploaded"; then
+  echo "Crate is already published: $CRATE_DIR"
+  exit 0
+fi
+
+echo "Publish command failed for $CRATE_DIR"
+echo "$OUTPUT"
+exit 1