Crates release GitHub action

Action for automatic incrementing of crate version and publishing to crates.io

Inputs:

• version, A version argument, Can be major/minor/patch or semver. For monorepos a JSON map of crate name to release argument
• crates-token, A crates.io publishing token (get from https://crates.io/settings/tokens)

Outputs:

• new-versions, A JSON array of crates and their new version e.g. [0.2.0]. For monorepos this is ["*crate-name*-*version*"] e.g. ["my-crate-0.2.0", "other-crate-0.3.0"]
• new-versions-json-object, A JSON object of crate name and new version pairs
• new-version, A single new version, "none" if multiple crates are updated e.g. [0.2.0].
• new-versions-description, For single projects the literal new version. For monorepos a chain of results e.g. crate1 to 0.1.0, crate2 to 0.2.0 and crate3 to 0.3.0

Example usage

The following example is a dispatch_workflow for updating updating the crate version, releasing on crates.io, creating a git tag and pushing updated Cargo.toml to the repository.

name: Release crate

on:
  workflow_dispatch:
    inputs:
      version:
        description: "major/minor/patch or semver"
        required: false
        default: "patch"

concurrency: release-crate

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Set git credentials
        run: |
          git config user.name github-actions
          git config user.email github-actions@github.com
      - name: Crates publish
        uses: kaleidawave/crates-release-gh-action@main
        id: release
        with:
          version: ${{ github.event.inputs.version }}
          crates-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}
      - name: Push updated Cargo.toml
        run: |
          git add .
          git commit -m "Release: ${{ steps.release.outputs.new-versions-description }}"
          git tag "release/${{ steps.release.outputs.new-version }}"
          git push --tags origin main

This can then be run either from the web gui:

or using the GitHub CLI:

gh workflow run crates.yml -f version=patch

Example usage in a monorepo

Useful if dealing with a associated derive crate. Here is a modification of the above that supports a repository with two crates.

name: Release crates

on:
  workflow_dispatch:
    inputs:
      crate1-version:
        description: "crate 1 major/minor/patch, a semver or none"
        required: false
        default: "patch"
      crate2-version:
        description: "crate 2 major/minor/patch, a semver or none"
        required: false
        default: "patch"

concurrency: release-crates

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Set git credentials
        run: |
          git config user.name github-actions
          git config user.email github-actions@github.com
      - name: Crates publish
        uses: kaleidawave/crates-release-gh-action@main
        id: release
        with:
          version: |
            { 
              "crate1": "${{ github.event.inputs.crate1-version }}", 
              "crate2": "${{ github.event.inputs.crate2-version }}" 
            }
          crates-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}
      - name: Push updated Cargo.toml
        run: |
          git add .
          git commit -m "Release: ${{ steps.release.outputs.new-versions-description }}"
          echo '${{ steps.release.outputs.new-versions }}' | jq -r '.[]' | while read -r update; do
            git tag "release/$update"
          done
          git push --tags origin main

Examples / demos

• syn-helpers
• temporary-annex
• enum-variants-strings (deploys two crates)
• ezno (deploys many crates + conditionally)