Skip to content

Merge pull request #31 from Miaxos/release-plz-2024-02-15T13-46-31Z #2

Merge pull request #31 from Miaxos/release-plz-2024-02-15T13-46-31Z

Merge pull request #31 from Miaxos/release-plz-2024-02-15T13-46-31Z #2

Workflow file for this run

# Adapted from https://github.com/BurntSushi/ripgrep/blob/master/.github/workflows/release.yml
#
name: release
on:
push:
tags:
# - '*'
- "v[0-9]+.[0-9]+.[0-9]+"
# We need this to be able to create releases.
permissions:
contents: write
jobs:
create-release:
name: create-release
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Get the release version from the tag
if: env.VERSION == ''
run: echo "${{ github.ref_name }}" | sed -En 's/^v(.*)$/VERSION=\1/p' >> $GITHUB_ENV
- name: Get the roster release version from the tag
if: env.RELEASE_NAME == ''
run: echo "RELEASE_NAME=${{ github.ref_name }}" >> $GITHUB_ENV
- name: Show the version
run: |
echo "version is: $VERSION"
- name: Check that tag version and Cargo.toml version are the same
shell: bash
run: |
if ! grep -q "version = \"$VERSION\"" Cargo.toml; then
echo "version does not match Cargo.toml" >&2
exit 1
fi
# TODO(@miaxos): When we have a way to specify tag name for one of the
# subpckage let's do it directly.
# https://github.com/MarcoIeni/release-plz/issues/680
- name: Create GitHub release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# run: gh release create $VERSION --draft --verify-tag --title $VERSION
run: gh release create v$VERSION --draft --title v$VERSION
outputs:
version: ${{ env.VERSION }}
release_name: ${{ env.RELEASE_NAME }}
build-release:
name: build-release
needs: ['create-release']
runs-on: ${{ matrix.os }}
env:
# For some builds, we use cross to test on 32-bit and big-endian
# systems.
CARGO: cargo
# When CARGO is set to CROSS, this is set to `--target matrix.target`.
TARGET_FLAGS:
# When CARGO is set to CROSS, TARGET_DIR includes matrix.target.
TARGET_DIR: ./target
# Bump this as appropriate. We pin to a version to make sure CI
# continues to work as cross releases in the past have broken things
# in subtle ways.
CROSS_VERSION: v0.2.5
# Emit backtraces on panics.
RUST_BACKTRACE: 1
# Build static releases with PCRE2.
PCRE2_SYS_STATIC: 1
# To ensure openssl is static linked
OPENSSL_STATIC: 1
strategy:
fail-fast: false
matrix:
include:
# - build: linux
# os: ubuntu-latest
# rust: nightly
# target: x86_64-unknown-linux-musl
# strip: x86_64-linux-musl-strip
- build: stable-x86
os: ubuntu-latest
rust: stable
target: x86_64-unknown-linux-gnu
qemu: i386
- build: stable-aarch64
os: ubuntu-latest
rust: stable
target: aarch64-unknown-linux-gnu
strip: aarch64-linux-gnu-strip
qemu: qemu-aarch64
# - build: stable-powerpc64
# os: ubuntu-latest
# rust: stable
# target: powerpc64-unknown-linux-gnu
# strip: powerpc64-linux-gnu-strip
# qemu: qemu-ppc64
# - build: stable-s390x
# os: ubuntu-latest
# rust: stable
# target: s390x-unknown-linux-gnu
# strip: s390x-linux-gnu-strip
# qemu: qemu-s390x
- build: macos
os: macos-latest
rust: nightly
target: x86_64-apple-darwin
- build: macos
os: macos-latest
rust: nightly
target: aarch64-apple-darwin
# - build: win-msvc
# os: windows-latest
# rust: nightly
# target: x86_64-pc-windows-msvc
# - build: win-gnu
# os: windows-2022
# rust: nightly-x86_64-gnu
# target: x86_64-pc-windows-gnu
steps:
- name: Checkout repository
uses: actions/checkout@v4
# - name: Install packages (Ubuntu)
# if: matrix.os == 'ubuntu-latest'
# shell: bash
# run: |
# ci/ubuntu-install-packages
- name: Install packages (Ubuntu)
if: matrix.os == 'ubuntu-latest'
shell: bash
run: |-
sudo apt-get update
sudo apt-get install -y openssl ca-certificates pkg-config cmake libssl-dev
- name: Install Rust
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.rust }}
target: ${{ matrix.target }}
- name: Use Cross
if: matrix.os == 'ubuntu-latest' && matrix.target != ''
shell: bash
run: |
# In the past, new releases of 'cross' have broken CI. So for now, we
# pin it. We also use their pre-compiled binary releases because cross
# has over 100 dependencies and takes a bit to compile.
dir="$RUNNER_TEMP/cross-download"
mkdir "$dir"
echo "$dir" >> $GITHUB_PATH
cd "$dir"
curl -LO "https://github.com/cross-rs/cross/releases/download/$CROSS_VERSION/cross-x86_64-unknown-linux-musl.tar.gz"
tar xf cross-x86_64-unknown-linux-musl.tar.gz
echo "CARGO=cross" >> $GITHUB_ENV
- name: Set target variables
shell: bash
run: |
echo "TARGET_FLAGS=--target ${{ matrix.target }}" >> $GITHUB_ENV
echo "TARGET_DIR=./target/${{ matrix.target }}" >> $GITHUB_ENV
- name: Show command used for Cargo
shell: bash
run: |
echo "cargo command is: ${{ env.CARGO }}"
echo "target flag is: ${{ env.TARGET_FLAGS }}"
echo "target dir is: ${{ env.TARGET_DIR }}"
- name: Build release binary
shell: bash
run: |
${{ env.CARGO }} build --bin roster --verbose --release ${{ env.TARGET_FLAGS }}
if [ "${{ matrix.os }}" = "windows-latest" ]; then
bin="target/${{ matrix.target }}/release/roster.exe"
else
bin="target/${{ matrix.target }}/release/roster"
fi
echo "BIN=$bin" >> $GITHUB_ENV
- name: Strip release binary (macos)
if: matrix.os == 'macos-latest'
shell: bash
run: strip "$BIN"
- name: Strip release binary (cross)
if: env.CARGO == 'cross' && matrix.strip != ''
shell: bash
run: |
docker run --rm -v \
"$PWD/target:/target:Z" \
"rustembedded/cross:${{ matrix.target }}" \
"${{ matrix.strip }}" \
"/target/${{ matrix.target }}/release/roster"
- name: Strip release binary (native strip)
if: matrix.os != 'macos-latest' && matrix.strip == ''
shell: bash
run: strip "$BIN"
- name: Determine archive name
shell: bash
run: |
version="${{ needs.create-release.outputs.version }}"
echo "ARCHIVE=roster-${{ matrix.target }}" >> $GITHUB_ENV
- name: Creating directory for archive
shell: bash
run: |
mkdir -p "$ARCHIVE"/{complete,doc}
cp "$BIN" "$ARCHIVE"/
cp README.md "$ARCHIVE"/
cp CHANGELOG.md "$ARCHIVE"/doc/
# - name: Generate man page and completions (no emulation)
# if: matrix.qemu == ''
# shell: bash
# run: |
# "$BIN" --version
# "$BIN" --generate complete-bash > "$ARCHIVE/complete/rg.bash"
# "$BIN" --generate complete-fish > "$ARCHIVE/complete/rg.fish"
# "$BIN" --generate complete-powershell > "$ARCHIVE/complete/_rg.ps1"
# "$BIN" --generate complete-zsh > "$ARCHIVE/complete/_rg"
# "$BIN" --generate man > "$ARCHIVE/doc/rg.1"
# - name: Generate man page and completions (emulation)
# if: matrix.qemu != ''
# shell: bash
# run: |
# docker run --rm -v \
# "$PWD/target:/target:Z" \
# "rustembedded/cross:${{ matrix.target }}" \
# "${{ matrix.qemu }}" "/$BIN" --version
# docker run --rm -v \
# "$PWD/target:/target:Z" \
# "rustembedded/cross:${{ matrix.target }}" \
# "${{ matrix.qemu }}" "/$BIN" \
# --generate complete-bash > "$ARCHIVE/complete/rg.bash"
# docker run --rm -v \
# "$PWD/target:/target:Z" \
# "rustembedded/cross:${{ matrix.target }}" \
# "${{ matrix.qemu }}" "/$BIN" \
# --generate complete-fish > "$ARCHIVE/complete/rg.fish"
# docker run --rm -v \
# "$PWD/target:/target:Z" \
# "rustembedded/cross:${{ matrix.target }}" \
# "${{ matrix.qemu }}" "/$BIN" \
# --generate complete-powershell > "$ARCHIVE/complete/_rg.ps1"
# docker run --rm -v \
# "$PWD/target:/target:Z" \
# "rustembedded/cross:${{ matrix.target }}" \
# "${{ matrix.qemu }}" "/$BIN" \
# --generate complete-zsh > "$ARCHIVE/complete/_rg"
# docker run --rm -v \
# "$PWD/target:/target:Z" \
# "rustembedded/cross:${{ matrix.target }}" \
# "${{ matrix.qemu }}" "/$BIN" \
# --generate man > "$ARCHIVE/doc/rg.1"
- name: Build archive (Windows)
shell: bash
if: matrix.os == 'windows-latest'
run: |
7z a "$ARCHIVE.zip" "$ARCHIVE"
certutil -hashfile "$ARCHIVE.zip" SHA256 > "$ARCHIVE.zip.sha256"
echo "ASSET=$ARCHIVE.zip" >> $GITHUB_ENV
echo "ASSET_SUM=$ARCHIVE.zip.sha256" >> $GITHUB_ENV
- name: Build archive (Unix)
shell: bash
if: matrix.os != 'windows-latest'
run: |
tar czf "$ARCHIVE.tar.gz" "$ARCHIVE"
shasum -a 256 "$ARCHIVE.tar.gz" > "$ARCHIVE.tar.gz.sha256"
echo "ASSET=$ARCHIVE.tar.gz" >> $GITHUB_ENV
echo "ASSET_SUM=$ARCHIVE.tar.gz.sha256" >> $GITHUB_ENV
- name: Upload release archive
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
shell: bash
run: |
release_name="v${{ needs.create-release.outputs.version }}"
gh release upload "$release_name" ${{ env.ASSET }} ${{ env.ASSET_SUM }}
# build-release-deb:
# name: build-release-deb
# needs: ['create-release']
# runs-on: ubuntu-latest
# env:
# TARGET: x86_64-unknown-linux-musl
# # Emit backtraces on panics.
# RUST_BACKTRACE: 1
# # Since we're distributing the dpkg, we don't know whether the user will
# # have PCRE2 installed, so just do a static build.
# PCRE2_SYS_STATIC: 1
# steps:
# - name: Checkout repository
# uses: actions/checkout@v4
# - name: Install packages (Ubuntu)
# shell: bash
# run: |
# ci/ubuntu-install-packages
# - name: Install Rust
# uses: dtolnay/rust-toolchain@master
# with:
# toolchain: nightly
# target: ${{ env.TARGET }}
# - name: Install cargo-deb
# shell: bash
# run: |
# cargo install cargo-deb
# # 'cargo deb' does not seem to provide a way to specify an asset that is
# # created at build time, such as ripgrep's man page. To work around this,
# # we force a debug build, copy out the man page (and shell completions)
# # produced from that build, put it into a predictable location and then
# # build the deb, which knows where to look.
# - name: Build debug binary to create release assets
# shell: bash
# run: |
# cargo build --target ${{ env.TARGET }}
# bin="target/${{ env.TARGET }}/debug/rg"
# echo "BIN=$bin" >> $GITHUB_ENV
# - name: Create deployment directory
# shell: bash
# run: |
# dir=deployment/deb
# mkdir -p "$dir"
# echo "DEPLOY_DIR=$dir" >> $GITHUB_ENV
# - name: Generate man page
# shell: bash
# run: |
# "$BIN" --generate man > "$DEPLOY_DIR/rg.1"
# - name: Generate shell completions
# shell: bash
# run: |
# "$BIN" --generate complete-bash > "$DEPLOY_DIR/rg.bash"
# "$BIN" --generate complete-fish > "$DEPLOY_DIR/rg.fish"
# "$BIN" --generate complete-zsh > "$DEPLOY_DIR/_rg"
# - name: Build release binary
# shell: bash
# run: |
# cargo deb --profile deb --target ${{ env.TARGET }}
# version="${{ needs.create-release.outputs.version }}"
# echo "DEB_DIR=target/${{ env.TARGET }}/debian" >> $GITHUB_ENV
# echo "DEB_NAME=ripgrep_$version-1_amd64.deb" >> $GITHUB_ENV
# - name: Create sha256 sum of deb file
# shell: bash
# run: |
# cd "$DEB_DIR"
# sum="$DEB_NAME.sha256"
# shasum -a 256 "$DEB_NAME" > "$sum"
# echo "SUM=$sum" >> $GITHUB_ENV
# - name: Upload release archive
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# shell: bash
# run: |
# cd "$DEB_DIR"
# version="${{ needs.create-release.outputs.version }}"
# gh release upload "$version" "$DEB_NAME" "$SUM"