Pipery Rust CI#

Repository: pipery-rust-ci
Release tag: v1.1.0
Catalog: /catalog/

Reusable GitHub Action for a complete Rust CI pipeline with structured logging via Pipery.

Table of Contents#

Quick Start
Pipeline Overview
Configuration Options
Usage Examples
GitLab CI
Bitbucket Pipelines
About Pipery
Development

Quick Start#

name: CI
on: [push, pull_request]

jobs:
  ci:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: pipery-dev/rust-ci@v1.1.0
        with:
          project_path: .
          crates_token: ${{ secrets.CRATES_TOKEN }}
          github_token: ${{ secrets.GITHUB_TOKEN }}

Pipeline Overview#

Step	Tool	Skip Input	Description
Lint	rustfmt, clippy	`skip_lint`	Enforces code style and linting rules
SAST	cargo-audit	`skip_sast`	Detects Rust security vulnerabilities
SCA	cargo-deny	`skip_sca`	Identifies vulnerable dependencies
Build	cargo build	`skip_build`	Compiles Rust project
Test	cargo test	`skip_test`	Runs unit and integration tests
Version	Semantic versioning	`skip_versioning`	Bumps version and creates git tag
Package	cargo build –release	`skip_packaging`	Creates release binary
Release	crates.io publish	`skip_release`	Publishes to crates.io
Reintegrate	Git merge	`skip_reintegration`	Merges back to default branch

Configuration Options#

Name	Default	Description
`project_path`	`.`	Path to the project source tree.
`config_file`	`.pipery/config.yaml`	Path to Pipery config file.
`rust_toolchain`	`stable`	Rust toolchain to use (e.g., `stable`, `nightly`, `1.75`).
`tests_path`	``	Test filter pattern passed to cargo test.
`features`	``	Cargo features to enable (comma-separated).
`target`	``	Cargo target triple (e.g., `x86_64-unknown-linux-musl`).
`version_bump`	`patch`	Version bump type: `patch`, `minor`, or `major`.
`target_branch`	`main`	Target branch for reintegration.
`crates_token`	``	crates.io API token for publishing.
`github_token`	``	GitHub token for release and reintegration.
`log_file`	`pipery.jsonl`	Path to the JSONL structured log file.
`skip_lint`	`false`	Skip the lint step.
`skip_sast`	`false`	Skip the SAST step.
`skip_sca`	`false`	Skip the SCA step.
`skip_build`	`false`	Skip the build step.
`skip_test`	`false`	Skip the test step.
`skip_versioning`	`false`	Skip the versioning step.
`skip_packaging`	`false`	Skip the packaging step.
`skip_release`	`false`	Skip the release step.
`skip_reintegration`	`false`	Skip the reintegration step.

Usage Examples#

Example 1: Standard Rust crate with stable toolchain#

name: CI
on: [push, pull_request]

jobs:
  ci:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: pipery-dev/rust-ci@v1.1.0
        with:
          project_path: .
          rust_toolchain: stable
          crates_token: ${{ secrets.CRATES_TOKEN }}
          github_token: ${{ secrets.GITHUB_TOKEN }}

Example 2: Nightly Rust with features enabled#

- uses: pipery-dev/rust-ci@v1.1.0
  with:
    project_path: .
    rust_toolchain: nightly
    features: serde,tokio,macros
    crates_token: ${{ secrets.CRATES_TOKEN }}
    github_token: ${{ secrets.GITHUB_TOKEN }}

Example 3: Cross-compile to musl target#

- uses: pipery-dev/rust-ci@v1.1.0
  with:
    project_path: .
    rust_toolchain: stable
    target: x86_64-unknown-linux-musl
    crates_token: ${{ secrets.CRATES_TOKEN }}
    github_token: ${{ secrets.GITHUB_TOKEN }}

Example 4: Run specific integration tests#

- uses: pipery-dev/rust-ci@v1.1.0
  with:
    project_path: .
    tests_path: integration_test
    github_token: ${{ secrets.GITHUB_TOKEN }}

Example 5: Skip security checks for development#

- uses: pipery-dev/rust-ci@v1.1.0
  with:
    project_path: .
    skip_sast: true
    skip_sca: true
    skip_release: true

Example 6: Major version bump for release#

- uses: pipery-dev/rust-ci@v1.1.0
  with:
    project_path: .
    rust_toolchain: stable
    version_bump: major
    crates_token: ${{ secrets.CRATES_TOKEN }}
    github_token: ${{ secrets.GITHUB_TOKEN }}

GitLab CI#

Use the GitLab mirror template when .gitlab-ci.yml is published for this pipeline family. Import it from the mirrored GitLab project or use it as a reference implementation for running the same Pipery pipeline outside GitHub Actions.

The GitLab pipeline maps action inputs to CI/CD variables, publishes pipery.jsonl as an artifact, and maintains the same skip controls. Store credentials as protected GitLab CI/CD variables.

include:
  - project: pipery-dev/rust-ci
    ref: v1.1.0
    file: /.gitlab-ci.yml

GitLab CI Variables#

Configure these protected variables in Settings > CI/CD > Variables:

CRATES_TOKEN - crates.io authentication token
GITHUB_TOKEN - GitHub API access for release and reintegration
RUST_TOOLCHAIN - Rust toolchain (default: stable)
VERSION_BUMP - patch/minor/major (default: patch)

Bitbucket Pipelines#

Bitbucket Cloud pipelines provide an alternative to GitHub Actions. Use Bitbucket shared pipeline imports to reference the exported Pipery pipeline instead of copying YAML into every application repository.

Getting Started#

Add a Bitbucket import source for the shared Pipery pipeline and import the exported pipeline by name:

definitions:
  imports:
    pipery-shared: pipery-dev/rust-ci:v1.1.0
    pipery-custom: pipery-dev/rust-ci:v1.1.0:.bitbucket/shared-pipelines.yml

pipelines:
  branches:
    main:
      import: pipery-rust-ci@pipery-shared

  custom:
    run-pipery:
      import: pipery-rust-ci@pipery-custom

Use {project-path}/{repo-slug}:{branch-or-tag} for a shared repository bitbucket-pipelines.yml, or {project-path}/{repo-slug}:{branch-or-tag}:{config-filepath} for another exported YAML file.

Configure Protected Variables in Repository Settings > Pipelines > Repository Variables:
- CRATES_TOKEN - crates.io authentication token
- GITHUB_TOKEN - GitHub API access (for release and reintegration)
- RUST_TOOLCHAIN - Rust toolchain (default: stable)
Commit and push to trigger the pipeline

Pipeline Stages#

The Bitbucket equivalent follows the same structure:

checkout → setup → lint (clippy) → SAST (cargo-audit) → SCA (cargo-deny) → build → test → versioning → packaging → release → reintegration → logs

Skip Flags#

Disable any stage using environment variables:

SKIP_LINT, SKIP_SAST, SKIP_SCA, SKIP_BUILD, SKIP_TEST, SKIP_VERSIONING, SKIP_PACKAGING, SKIP_RELEASE, SKIP_REINTEGRATION

Example: Set SKIP_SAST=true to skip security scanning.

Features#

Multiple Rust toolchains (stable, nightly, pinned)
Feature flag testing
Cross-compilation support
Cargo security scanning
Dependency vulnerability checking
Automatic crates.io publishing
JSONL-based pipeline logging
30-90 day artifact retention

About Pipery#

Pipery Pipery is an open-source CI/CD observability platform. Every step script runs under psh (Pipery Shell), which intercepts all commands and emits structured JSONL events — giving you full visibility into your pipeline without any manual instrumentation.

Browse logs in the Pipery Dashboard
Find all Pipery actions on GitHub Marketplace
Source code: pipery-dev

Development#

# Run the action locally against test-project/
pipery-actions test --repo .

# Regenerate docs
pipery-actions docs --repo .

# Dry-run release
pipery-actions release --repo . --dry-run