crates.io workflow

Author: abutlabs

.github/workflows/release.yml

@@ -0,0 +1,110 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'  # Triggers on version tags like v0.1.0, v1.0.0
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  # Run tests before releasing
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Run tests
+        run: cargo test --lib
+
+      - name: Check formatting
+        run: cargo fmt --all -- --check
+
+      - name: Clippy
+        run: cargo clippy --all-targets --all-features -- -D warnings
+
+  # Publish to crates.io
+  publish:
+    name: Publish to crates.io
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Publish to crates.io
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+        run: cargo publish
+
+  # Create GitHub Release with binaries
+  release:
+    name: Build Release Binaries
+    runs-on: ${{ matrix.os }}
+    needs: test
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+            artifact: cargo-jam-linux-x86_64
+          - os: macos-latest
+            target: x86_64-apple-darwin
+            artifact: cargo-jam-macos-x86_64
+          - os: macos-latest
+            target: aarch64-apple-darwin
+            artifact: cargo-jam-macos-aarch64
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: ${{ matrix.target }}
+
+      - name: Build release binary
+        run: cargo build --release --target ${{ matrix.target }}
+
+      - name: Package binary (Unix)
+        run: |
+          cd target/${{ matrix.target }}/release
+          tar -czvf ../../../${{ matrix.artifact }}.tar.gz cargo-jam
+          cd ../../..
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.artifact }}
+          path: ${{ matrix.artifact }}.tar.gz
+
+  # Create GitHub Release
+  github-release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    needs: [release, publish]
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: artifacts/**/*.tar.gz
+          generate_release_notes: true
+          draft: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -6,6 +6,10 @@ cargo, make me a JAM service
 
 A Rust cargo subcommand for generating and building JAM (Join-Accumulate Machine) services for Polkadot. Follows the [cargo-generate](https://github.com/cargo-generate/cargo-generate) project architecture while providing JAM-specific tooling.
 
+## Demo
+
+
+
 ## Installation
 
 ### Install From crates.io
@@ -453,7 +457,36 @@ The testnet tests will:
 2. Build it to a `.jam` blob
 3. Deploy it to the running testnet using `cargo jam deploy`
 
-## Publishing to crates.io
+## Publishing & Releases
+
+### Automated Releases (Recommended)
+
+This repo has CI/CD that automatically publishes to crates.io when you create a version tag:
+
+**One-time setup:**
+1. Get your crates.io API token from https://crates.io/settings/tokens
+2. Add it as a GitHub secret: Settings → Secrets → Actions → New secret
+   - Name: `CARGO_REGISTRY_TOKEN`
+   - Value: your token
+
+**To release a new version:**
+```bash
+# Update version in Cargo.toml
+# Commit changes
+git add . && git commit -m "Release v0.1.0"
+
+# Create and push a version tag
+git tag v0.1.0
+git push origin main --tags
+```
+
+This triggers the release workflow which:
+1. Runs all tests and lints
+2. Publishes to crates.io
+3. Builds binaries for Linux and macOS
+4. Creates a GitHub Release with downloadable binaries
+
+### Manual Publishing
 
 ```bash
 # Login to crates.io