semantic-release-cargo integrates a cargo-based Rust project with [semantic-release]. This solves two use cases:
After following these instructions, you will have a semantic-release pipeline that publishes your Rust crate to crates.io.
You must set the CARGO_REGISTRY_TOKEN environment variable.
This workflow is supported on the following systems:
| System | Supported? | | ------------- | ---------- | | macOS aarch64 | ✓ | | macOS x64 | ✓ | | Linux x64 gnu | ✓ |
Install semantic-release-cargo with npm:
bash
$ npm install --save-dev --save-exact @semantic-release-cargo/semantic-release-cargo
Add semantic-release-cargo to your semantic-release configuration in .releaserc.json:
json
{
"plugins": ["@semantic-release-cargo/semantic-release-cargo"]
}
If you're not keen to mix npm with your Rust project, you can use the [semantic-release-action].
After following these instructions, you will have a GitHub Actions workflow
that sets the next version number in Cargo.toml and compiles your crate's
release binaries.
Updating the cargo manifest with the next version number lets you reference the next version in the compiled binary, for example with the [clap::crate_version] macro.
The compiled binaries can be uploaded to a GitHub release using the [@semantic-release/github] plugin.
This workflow is supported on the following systems:
| System | Supported? | | ------------- | ---------- | | macOS aarch64 | ✓ | | macOS x64 | ✓ | | Linux aarch64 | ✓ | | Linux x64 | ✓ | | Linux x86 | ✓ |
In the first job, use the [semantic-release-export-data] plugin to save the next release version as GitHub Actions outputs:
```yaml jobs: get-next-version: name: Calculate next release runs-on: ubuntu-latest outputs: new-release-published: ${{ steps.get-next-version.outputs.new-release-published }} new-release-version: ${{ steps.get-next-version.outputs.new-release-version }}
steps:
- name: Checkout
uses: actions/checkout@v3
with:
# Fetch all history and tags for calculating next semantic version
fetch-depth: 0
- name: Configure Node.js
uses: actions/setup-node@v3
with:
node-version: lts/*
cache: npm
- name: Install npm dependencies
run: npm ci --ignore-scripts
- name: Calculate next semantic-release version
id: get-next-version
run: ./node_modules/.bin/semantic-release --dry-run --verify-conditions semantic-release-export-data --generate-notes semantic-release-export-data
```
In the next job, use semantic-release-cargo to set the crate version before compilation:
```yaml build: name: Build runs-on: ubuntu-latest needs: - get-next-version
steps: - name: Checkout uses: actions/checkout@v3
- name: Install toolchain
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
override: true
target: x86_64-unknown-linux-gnu
- name: Install semantic-release-cargo
if: needs.get-next-version.outputs.new-release-published == 'true'
uses: taiki-e/install-action@v1
with:
tool: semantic-release-cargo@2
- name: Prepare semantic-release for Rust
if: needs.get-next-version.outputs.new-release-published == 'true'
run: semantic-release-cargo prepare ${{ needs.get-next-version.outputs.new-release-version }}
- name: Cargo build
uses: actions-rs/cargo@v1
with:
command: build
args: --all-targets --target=x86_64-unknown-linux-gnu --release --verbose
```
You can create a single GitHub Actions workflow that combines both use cases. This repository uses semantic-release-cargo with semantic-release to publish to crates.io and create a GitHub Release with precompiled binaries.
See [release.yml] for a working example.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in semantic-release-cargo by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
This repository has been forked from [kettleby/semantic-release-rust]. All credit goes to the original author.