Skip to content

Update ci.yml

Update ci.yml #2375

Workflow file for this run

name: Build/Test/Release
on:
push:
tags: [ "v*" ]
branches: [ "master" ]
pull_request:
branches: [ "master" ]
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
env:
PACKAGE: "clash"
REGISTRY: "ghcr.io"
IMAGE_NAME: "clash-rs"
RUST_LOG: "clash=TRACE"
# Arm builder https://github.blog/changelog/2024-09-03-github-actions-arm64-linux-and-windows-runners-are-now-generally-available/
jobs:
compile:
name: ${{ matrix.release-name || matrix.target || 'Unknown' }}
permissions:
contents: write
runs-on: ${{ matrix.os || 'ubuntu-latest' }}
strategy:
fail-fast: false
matrix:
include:
# Example
# when not set, default will be used (except target, cross)
# - os: ubuntu-latest
# target: x86_64-unknown-linux-gnu
# release-name: $target
# toolchain: nightly
# cross: false
# postfix: ""
# extra-args: ""
# components: ""
# rustflags: "--cfg tokio_unstable"
# Linux x86 gnu
- os: ubuntu-latest
target: x86_64-unknown-linux-gnu
cross: true
extra-args: "--all-features"
- os: ubuntu-latest
target: i686-unknown-linux-gnu
cross: true
extra-args: "--all-features"
# Linux x86 musl
- os: ubuntu-latest
target: x86_64-unknown-linux-musl
cross: true
extra-args: "--all-features"
# Linux x86 gnu static-crt
- os: ubuntu-latest
target: x86_64-unknown-linux-gnu
release-name: x86_64-unknown-linux-gnu-static-crt
cross: true
extra-args: "--all-features"
rustflags: "-Ctarget-feature=+crt-static --cfg tokio_unstable"
- os: ubuntu-latest
target: i686-unknown-linux-gnu
release-name: i686-unknown-linux-gnu-static-crt
cross: true
extra-args: "--all-features"
rustflags: "-Ctarget-feature=+crt-static --cfg tokio_unstable"
# Linux arm gnu
- os: ubuntu-latest
target: aarch64-unknown-linux-gnu
cross: true
extra-args: "--all-features"
- os: ubuntu-latest
target: armv7-unknown-linux-gnueabi
cross: true
extra-args: "--all-features"
- os: ubuntu-latest
target: armv7-unknown-linux-gnueabihf
cross: true
extra-args: "--all-features"
# Linux arm musl
- os: ubuntu-latest
target: aarch64-unknown-linux-musl
cross: true
extra-args: "--all-features"
- os: ubuntu-latest
target: armv7-unknown-linux-musleabihf
cross: true
extra-args: "--all-features"
# Linux arm gnu static-crt
- os: ubuntu-latest
target: aarch64-unknown-linux-gnu
release-name: aarch64-unknown-linux-gnu-static-crt
cross: true
extra-args: "--all-features"
rustflags: "-Ctarget-feature=+crt-static --cfg tokio_unstable"
- os: ubuntu-latest
target: armv7-unknown-linux-gnueabi
release-name: armv7-unknown-linux-gnueabi-static-crt
cross: true
extra-args: "--all-features"
rustflags: "-Ctarget-feature=+crt-static --cfg tokio_unstable"
# Linux RISC-V gnu
# - os: ubuntu-latest
# target: riscv64gc-unknown-linux-gnu
# cross: true
# extra-args: "--all-features"
# Windows
- os: windows-latest
target: x86_64-pc-windows-msvc
cross: false
postfix: ".exe"
extra-args: "--all-features"
- os: windows-latest
target: i686-pc-windows-msvc
cross: false
postfix: ".exe"
extra-args: "--all-features"
- os: windows-latest
target: aarch64-pc-windows-msvc
cross: false
postfix: ".exe"
extra-args: --features "shadowsocks tuic"
# Windows static-crt
- os: windows-latest
target: x86_64-pc-windows-msvc
release-name: x86_64-pc-windows-msvc-static-crt
cross: false
postfix: ".exe"
extra-args: "--all-features"
rustflags: "-Ctarget-feature=+crt-static --cfg tokio_unstable"
- os: windows-latest
target: i686-pc-windows-msvc
release-name: i686-pc-windows-msvc-static-crt
cross: false
postfix: ".exe"
extra-args: "--all-features"
rustflags: >-
-Ctarget-feature=+crt-static
-Clink-args=/NODEFAULTLIB:libvcruntimed.lib
-Clink-args=/NODEFAULTLIB:vcruntime.lib
-Clink-args=/NODEFAULTLIB:vcruntimed.lib
-Clink-args=/NODEFAULTLIB:libcmtd.lib
-Clink-args=/NODEFAULTLIB:msvcrt.lib
-Clink-args=/NODEFAULTLIB:msvcrtd.lib
-Clink-args=/NODEFAULTLIB:libucrt.lib
-Clink-args=/NODEFAULTLIB:libucrtd.lib
-Clink-args=/DEFAULTLIB:libcmt.lib
-Clink-args=/DEFAULTLIB:libvcruntime.lib
-Clink-args=/DEFAULTLIB:ucrt.lib
--cfg tokio_unstable
- os: windows-latest
target: aarch64-pc-windows-msvc
release-name: aarch64-pc-windows-msvc-static-crt
cross: false
postfix: ".exe"
extra-args: --features "shadowsocks tuic"
rustflags: "-Ctarget-feature=+crt-static --cfg tokio_unstable"
# MacOSX
- os: macos-12
target: x86_64-apple-darwin
cross: false
extra-args: "--all-features"
- os: macos-14
target: aarch64-apple-darwin
cross: false
extra-args: "--all-features"
# MacOSX static-crt
- os: macos-12
target: x86_64-apple-darwin
release-name: x86_64-apple-darwin-static-crt
cross: false
extra-args: "--all-features"
rustflags: "-Ctarget-feature=+crt-static --cfg tokio_unstable"
- os: macos-14
target: aarch64-apple-darwin
release-name: aarch64-apple-darwin-static-crt
cross: false
extra-args: "--all-features"
rustflags: "-Ctarget-feature=+crt-static --cfg tokio_unstable"
# Linux mips: tier-3, pity
# Windows gnu: tokio dont work
# Windows aarch: todo
steps:
- uses: actions/checkout@v4
with:
submodules: true
- uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ matrix.release-name || matrix.target }}-${{ hashFiles('**/Cargo.toml') }}
restore-keys: |
${{ matrix.release-name || matrix.target }}
- uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.toolchain || 'nightly-2024-09-20' }} # until https://github.com/rust-lang/rust-clippy/issues/13457
target: ${{ matrix.target }}
components: ${{ matrix.components || 'rustfmt, clippy' }}
- name: Install Protoc
uses: arduino/setup-protoc@v3
with:
version: "23.x"
repo-token: ${{ secrets.GITHUB_TOKEN }}
- name: Set environment variables
run: |
echo "CLASH_GIT_REF=${GITHUB_REF}" >> $GITHUB_ENV
echo "CLASH_GIT_SHA=${GITHUB_SHA}" >> $GITHUB_ENV
- name: Cargo fmt
uses: clechasseur/rs-cargo@v2
with:
use-cross: ${{ matrix.cross }}
command: fmt
args: --all -- --check
env:
CLASH_DOCKER_TEST: "true"
- name: Cargo clippy
uses: clechasseur/rs-cargo@v2
with:
use-cross: ${{ matrix.cross }}
command: clippy
args: --all --target ${{ matrix.target }} ${{ matrix.extra-args }} -- -D warnings
env:
CLASH_DOCKER_TEST: "true"
- name: Cargo test (docker test on linux)
uses: clechasseur/rs-cargo@v2
if: startsWith(matrix.os, 'ubuntu')
with:
use-cross: ${{ matrix.cross }}
command: test
args: --all --target ${{ matrix.target }} ${{ matrix.extra-args }}
env:
CROSS_CONTAINER_OPTS: "--network host"
CLASH_DOCKER_TEST: "true"
RUSTFLAGS: ${{ matrix.rustflags || '--cfg tokio_unstable' }}
- name: Cargo test (no docker test on windows-non-arm and macos)
uses: clechasseur/rs-cargo@v2
if: ${{ !startsWith(matrix.os, 'ubuntu') && matrix.target != 'aarch64-pc-windows-msvc' }}
with:
use-cross: ${{ matrix.cross }}
command: test
args: --all --target ${{ matrix.target }} ${{ matrix.extra-args }}
env:
RUSTFLAGS: ${{ matrix.rustflags || '--cfg tokio_unstable' }}
- name: Cargo build
uses: clechasseur/rs-cargo@v2
with:
use-cross: ${{ matrix.cross }}
command: build
args: --release --target ${{ matrix.target }} ${{ matrix.extra-args }}
env:
RUSTFLAGS: ${{ matrix.rustflags || '--cfg tokio_unstable' }}
- name: Rename binary
run: mv target/${{ matrix.target }}/release/clash-rs${{ matrix.postfix }} ${{ env.PACKAGE }}-${{ matrix.release-name || matrix.target }}${{ matrix.postfix }}
- name: Upload binaries
uses: actions/upload-artifact@v4
with:
name: ${{ matrix.release-name || matrix.target }}
path: ${{ env.PACKAGE }}-${{ matrix.release-name || matrix.target }}${{ matrix.postfix }}
- name: Setup tmate session
if: ${{ failure() }}
uses: mxschmitt/action-tmate@v3
with:
detached: true
timeout-minutes: 15
limit-access-to-actor: true
release:
name: Release
needs: [ compile ]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
fetch-tags: true
- name: Merge binaries
uses: actions/upload-artifact/merge@v4
with:
name: binaries
pattern: '*'
retention-days: 1
- name: Download binaries
uses: actions/download-artifact@v4
with:
name: binaries
path: ./packages
- name: Create SHA256Sums.txt and version.txt
run: |
cd packages
sha256sum * >> sha256sums.txt
cat sha256sums.txt
chmod +x ./clash-x86_64-unknown-linux-musl
./clash-x86_64-unknown-linux-musl -v >> version.txt
cat version.txt
- name: Move latest tag for git-cliff nightly
run: |
git tag latest -f
- name: Generate a changelog
uses: orhun/git-cliff-action@main
id: git-cliff
with:
config: .github/cliff.toml
args: --latest --strip header
env:
GITHUB_REPO: ${{ github.repository }}
- name: Github stable release
uses: softprops/action-gh-release@v2
if: startsWith(github.ref, 'refs/tags/v')
with:
token: ${{ secrets.GITHUB_TOKEN }}
prerelease: false
generate_release_notes: false
body: ${{ steps.git-cliff.outputs.content }}
files: |
packages/*
LICENSE*
- name: Delete old latest nightly release
if: startsWith(github.ref, 'refs/heads/master')
uses: actions/github-script@v7
with:
github-token: ${{secrets.GITHUB_TOKEN}}
script: |
const tag = 'latest'
const { owner, repo } = context.repo
const { data: { id } } = await github.rest.repos.getReleaseByTag({ owner, repo, tag })
await github.rest.repos.deleteRelease({ owner, repo, release_id: id })
- name: Update Latest Tag
if: startsWith(github.ref, 'refs/heads/master')
uses: richardsimko/update-tag@v1
with:
tag_name: latest
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Github nightly release
uses: softprops/action-gh-release@v2
if: startsWith(github.ref, 'refs/heads/master')
with:
token: ${{ secrets.GITHUB_TOKEN }}
prerelease: true
tag_name: "latest"
generate_release_notes: false
body: ${{ steps.git-cliff.outputs.content }}
files: |
packages/*
LICENSE*
docker-image:
needs: [ compile ]
name: Docker Image
if: ${{ startsWith(github.ref, 'refs/tags/v') }}
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Set docker image's tag
run: |
echo "TAG_VERSION=${REGISTRY}/${GITHUB_REPOSITORY_OWNER@L}/${IMAGE_NAME}:${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
echo "TAG_LATEST=${REGISTRY}/${GITHUB_REPOSITORY_OWNER@L}/${IMAGE_NAME}:latest" >> $GITHUB_ENV
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Download binaries amd64
uses: actions/download-artifact@v4
with:
name: x86_64-unknown-linux-musl
path: ./clash-rs
- name: Download binaries arm64
uses: actions/download-artifact@v4
with:
name: aarch64-unknown-linux-musl
path: ./clash-rs
- name: Rename binary
run: |
mv ./clash-rs/clash-x86_64-unknown-linux-musl ./clash-rs/clash-amd64
mv ./clash-rs/clash-aarch64-unknown-linux-musl ./clash-rs/clash-arm64
- name: Log in to Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ env.OWNER }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Build and push release
uses: docker/build-push-action@v6
with:
context: .
file: .github/Dockerfile
platforms: linux/amd64,linux/arm64
push: true
tags: ${{ env.TAG_VERSION }},${{ env.TAG_LATEST }}