From 34d34b0878581bbdef057baeda7bce23d1f5adc3 Mon Sep 17 00:00:00 2001 From: Felipe Coury Date: Tue, 2 Jul 2024 16:45:24 -0300 Subject: [PATCH] feat: release GitHub action --- .github/workflows/release.yml | 354 ++++++++++++++++++++++++++++++++++ Cargo.toml | 1 + 2 files changed, 355 insertions(+) create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..694a234 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,354 @@ +name: release + +# Only do the release on x.y.z tags. +on: + push: + tags: + - "[0-9]+.[0-9]+.[0-9]+" + +# We need this to be able to create releases. +permissions: + contents: write + +jobs: + # The create-release job runs purely to initialize the GitHub release itself, + # and names the release after the `x.y.z` tag that was pushed. It's separate + # from building the release so that we only create the release once. + 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 "VERSION=${{ 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 + - name: Create GitHub release + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: gh release create $VERSION --draft --verify-tag --title $VERSION + outputs: + version: ${{ env.VERSION }} + + 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 + 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: i686-unknown-linux-gnu + strip: x86_64-linux-gnu-strip + 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-arm-gnueabihf + os: ubuntu-latest + rust: stable + target: armv7-unknown-linux-gnueabihf + strip: arm-linux-gnueabihf-strip + qemu: qemu-arm + - build: stable-arm-musleabihf + os: ubuntu-latest + rust: stable + target: armv7-unknown-linux-musleabihf + strip: arm-linux-musleabihf-strip + qemu: qemu-arm + - build: stable-arm-musleabi + os: ubuntu-latest + rust: stable + target: armv7-unknown-linux-musleabi + strip: arm-linux-musleabi-strip + qemu: qemu-arm + - build: macos + os: macos-latest + rust: nightly + target: x86_64-apple-darwin + - build: win-msvc + os: windows-latest + rust: nightly + target: x86_64-pc-windows-msvc + - build: win-gnu + os: windows-latest + rust: nightly-x86_64-gnu + target: x86_64-pc-windows-gnu + - build: win32-msvc + os: windows-latest + rust: nightly + target: i686-pc-windows-msvc + + 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 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 --verbose --release ${{ env.TARGET_FLAGS }} + if [ "${{ matrix.os }}" = "windows-latest" ]; then + bin="target/${{ matrix.target }}/release/vial.exe" + else + bin="target/${{ matrix.target }}/release/vial" + 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' + shell: bash + run: | + docker run --rm -v \ + "$PWD/target:/target:Z" \ + "ghcr.io/cross-rs/${{ matrix.target }}:main" \ + "${{ matrix.strip }}" \ + "/$BIN" + + - name: Determine archive name + shell: bash + run: | + version="${{ needs.create-release.outputs.version }}" + echo "ARCHIVE=vial-$version-${{ matrix.target }}" >> $GITHUB_ENV + + - name: Creating directory for archive + shell: bash + run: | + mkdir -p "$ARCHIVE"/{complete,doc} + cp "$BIN" "$ARCHIVE"/ + cp {README.md,LICENSE} "$ARCHIVE"/ + # cp {CHANGELOG.md,FAQ.md,GUIDE.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" \ + # "ghcr.io/cross-rs/${{ matrix.target }}:main" \ + # "${{ matrix.qemu }}" "/$BIN" --version + # docker run --rm -v \ + # "$PWD/target:/target:Z" \ + # "ghcr.io/cross-rs/${{ matrix.target }}:main" \ + # "${{ matrix.qemu }}" "/$BIN" \ + # --generate complete-bash > "$ARCHIVE/complete/rg.bash" + # docker run --rm -v \ + # "$PWD/target:/target:Z" \ + # "ghcr.io/cross-rs/${{ matrix.target }}:main" \ + # "${{ matrix.qemu }}" "/$BIN" \ + # --generate complete-fish > "$ARCHIVE/complete/rg.fish" + # docker run --rm -v \ + # "$PWD/target:/target:Z" \ + # "ghcr.io/cross-rs/${{ matrix.target }}:main" \ + # "${{ matrix.qemu }}" "/$BIN" \ + # --generate complete-powershell > "$ARCHIVE/complete/_rg.ps1" + # docker run --rm -v \ + # "$PWD/target:/target:Z" \ + # "ghcr.io/cross-rs/${{ matrix.target }}:main" \ + # "${{ matrix.qemu }}" "/$BIN" \ + # --generate complete-zsh > "$ARCHIVE/complete/_rg" + # docker run --rm -v \ + # "$PWD/target:/target:Z" \ + # "ghcr.io/cross-rs/${{ matrix.target }}:main" \ + # "${{ 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: | + version="${{ needs.create-release.outputs.version }}" + gh release upload "$version" ${{ 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 + # + # 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/vial" + # 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=vial_$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" diff --git a/Cargo.toml b/Cargo.toml index c56db66..79febbe 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,7 @@ name = "vial" version = "0.1.0" edition = "2021" +license = "MIT" [dependencies] anyhow = "1.0.86"