Skip to content

ci: create release workflow that uses cargo release #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Release

on:
workflow_dispatch:
inputs:
level:
description: 'Release level'
required: true
default: 'patch'
type: choice
options:
- patch
- minor
- major

defaults:
run:
shell: bash

jobs:
release:
runs-on: ubuntu-latest
# The permissions should allow the user to:
# 1. Push to the branch of the repository that triggered the workflow.
# 2. Create a tag.
# 3. Push to crates.io.
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Install required packages
run: sudo apt install --no-install-recommends --yes libhwloc-dev nvidia-cuda-toolkit ocl-icd-opencl-dev
Copy link
Preview

Copilot AI Jul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Installing packages with sudo without specifying versions could introduce security risks. Consider pinning package versions or using a container image with pre-installed dependencies for more reproducible and secure builds.

Suggested change
run: sudo apt install --no-install-recommends --yes libhwloc-dev nvidia-cuda-toolkit ocl-icd-opencl-dev
run: sudo apt install --no-install-recommends --yes libhwloc-dev=2.4.1-1 nvidia-cuda-toolkit=11.5.2-1 ocl-icd-opencl-dev=2.2.12-2

Copilot uses AI. Check for mistakes.

- name: Install cargo release
run: cargo install --version 0.25.17 cargo-release
Copy link
Preview

Copilot AI Jul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The cargo-release version is pinned to a specific version (0.25.17). Consider using a more recent version or document why this specific version is required, as newer versions may contain bug fixes and improvements.

Suggested change
run: cargo install --version 0.25.17 cargo-release
run: cargo install cargo-release

Copilot uses AI. Check for mistakes.

- name: Set git user
run: |
git config --global user.email "${GITHUB_TRIGGERING_ACTOR}@users.noreply.github.com>"
Copy link
Preview

Copilot AI Jul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is an extra closing angle bracket '>' at the end of the email address. It should be '${GITHUB_TRIGGERING_ACTOR}@users.noreply.github.com' without the trailing '>'.

Suggested change
git config --global user.email "${GITHUB_TRIGGERING_ACTOR}@users.noreply.github.com>"
git config --global user.email "${GITHUB_TRIGGERING_ACTOR}@users.noreply.github.com"

Copilot uses AI. Check for mistakes.

git config --global user.name "${GITHUB_TRIGGERING_ACTOR}"
- name: Run cargo release
env:
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
CARGO_REGISTRY_TOKEN: ${{ secrets.FILOZZY_CI_CARGO_PUBLISH_UPDATE_TOKEN }}

I debated about the name here, but I thought best to make this an organizational token at which point CARGO_REGISTRY_TOKEN would be too broad for the organization.

run: cargo release ${{ github.event.inputs.level }} --no-confirm --execute
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ bincode = "1.1.2"
blstrs = "0.7"
lazy_static = "1.2"
serde = "1.0.104"
filecoin-proofs-v1 = { package = "filecoin-proofs", version = "~18.1.0", default-features = false }
fr32 = { version = "~11.1.0", default-features = false }
storage-proofs-core = { version = "~18.1.0", default-features = false }
filecoin-proofs-v1 = { package = "filecoin-proofs", version = "~19.0.0", default-features = false }
fr32 = { version = "~12.0.0", default-features = false }
storage-proofs-core = { version = "~19.0.0", default-features = false }

[features]
default = ["opencl", "cuda"]
Expand Down
Loading