fix: 修改 README.md #4
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CICD | |
| env: | |
| MIN_SUPPORTED_RUST_VERSION: "1.60.0" | |
| CICD_INTERMEDIATES_DIR: "_cicd-intermediates" | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - 'v[0-9]+.*' | |
| jobs: | |
| ensure_cargo_fmt: | |
| name: Ensure 'cargo fmt' has been run | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| default: true | |
| profile: minimal | |
| components: rustfmt | |
| - uses: actions/checkout@v3 | |
| - run: cargo fmt -- --check | |
| build: | |
| name: ${{ matrix.job.target }} (${{ matrix.job.os }}) | |
| runs-on: ${{ matrix.job.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| job: | |
| - { target: aarch64-unknown-linux-gnu , os: ubuntu-20.04, use-cross: true } | |
| - { target: aarch64-apple-darwin , os: macos-latest, } | |
| - { target: arm-unknown-linux-gnueabihf , os: ubuntu-20.04, use-cross: true } | |
| - { target: arm-unknown-linux-musleabihf, os: ubuntu-20.04, use-cross: true } | |
| - { target: i686-pc-windows-msvc , os: windows-2019 } | |
| - { target: i686-unknown-linux-gnu , os: ubuntu-20.04, use-cross: true } | |
| # - { target: i686-unknown-linux-musl , os: ubuntu-20.04, use-cross: true } | |
| - { target: x86_64-apple-darwin , os: macos-10.15 } | |
| # - { target: x86_64-pc-windows-gnu , os: ubuntu-20.04, use-cross: true } | |
| - { target: x86_64-pc-windows-msvc , os: windows-2019 } | |
| - { target: x86_64-unknown-linux-gnu , os: ubuntu-20.04, use-cross: true } | |
| # - { target: x86_64-unknown-linux-musl , os: ubuntu-20.04, use-cross: true } | |
| steps: | |
| - name: Checkout source code | |
| uses: actions/checkout@v3 | |
| - name: Install prerequisites | |
| shell: bash | |
| run: | | |
| case ${{ matrix.job.target }} in | |
| arm-unknown-linux-*) sudo apt-get -y update ; sudo apt-get -y install gcc-arm-linux-gnueabihf ;; | |
| aarch64-unknown-linux-gnu) sudo apt-get -y update ; sudo apt-get -y install gcc-aarch64-linux-gnu ;; | |
| esac | |
| - name: Extract crate information | |
| shell: bash | |
| run: | | |
| echo "PROJECT_NAME=$(sed -n 's/^name = "\(.*\)"/\1/p' Cargo.toml | head -n1)" >> $GITHUB_ENV | |
| echo "PROJECT_VERSION=$(sed -n 's/^version = "\(.*\)"/\1/p' Cargo.toml | head -n1)" >> $GITHUB_ENV | |
| echo "PROJECT_MAINTAINER=$(sed -n 's/^authors = \["\(.*\)"\]/\1/p' Cargo.toml)" >> $GITHUB_ENV | |
| echo "PROJECT_HOMEPAGE=$(sed -n 's/^homepage = "\(.*\)"/\1/p' Cargo.toml)" >> $GITHUB_ENV | |
| - name: Install Rust toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| target: ${{ matrix.job.target }} | |
| override: true | |
| profile: minimal # minimal component installation (ie, no documentation) | |
| - name: Show version information (Rust, cargo, GCC) | |
| shell: bash | |
| run: | | |
| gcc --version || true | |
| rustup -V | |
| rustup toolchain list | |
| rustup default | |
| cargo -V | |
| rustc -V | |
| perl -V | |
| - name: Build | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| use-cross: ${{ matrix.job.use-cross }} | |
| command: build | |
| args: --locked --release --target=${{ matrix.job.target }} | |
| - name: Strip debug information from executable | |
| id: strip | |
| shell: bash | |
| run: | | |
| # Figure out suffix of binary | |
| EXE_suffix="" | |
| case ${{ matrix.job.target }} in | |
| *-pc-windows-*) EXE_suffix=".exe" ;; | |
| esac; | |
| # Figure out what strip tool to use if any | |
| STRIP="strip" | |
| case ${{ matrix.job.target }} in | |
| arm-unknown-linux-*) STRIP="arm-linux-gnueabihf-strip" ;; | |
| aarch64-unknown-linux-gnu) STRIP="aarch64-linux-gnu-strip" ;; | |
| *-pc-windows-msvc) STRIP="" ;; | |
| esac; | |
| # Setup paths | |
| BIN_DIR="${{ env.CICD_INTERMEDIATES_DIR }}/stripped-release-bin/" | |
| mkdir -p "${BIN_DIR}" | |
| BIN_NAME="${{ env.PROJECT_NAME }}${EXE_suffix}" | |
| BIN_PATH="${BIN_DIR}/${BIN_NAME}" | |
| # Copy the release build binary to the result location | |
| cp "target/${{ matrix.job.target }}/release/${BIN_NAME}" "${BIN_DIR}" | |
| # Also strip if possible | |
| if [ -n "${STRIP}" ]; then | |
| "${STRIP}" "${BIN_PATH}" | |
| fi | |
| # Let subsequent steps know where to find the (stripped) bin | |
| echo ::set-output name=BIN_PATH::${BIN_PATH} | |
| echo ::set-output name=BIN_NAME::${BIN_NAME} | |
| - name: Set testing options | |
| id: test-options | |
| shell: bash | |
| run: | | |
| # test only library unit tests and binary for arm-type targets | |
| unset CARGO_TEST_OPTIONS | |
| unset CARGO_TEST_OPTIONS ; case ${{ matrix.job.target }} in arm-* | aarch64-*) CARGO_TEST_OPTIONS="--lib --bin ${PROJECT_NAME}" ;; esac; | |
| echo ::set-output name=CARGO_TEST_OPTIONS::${CARGO_TEST_OPTIONS} | |
| - name: Create tarball | |
| id: package | |
| shell: bash | |
| run: | | |
| PKG_suffix=".tar.gz" ; case ${{ matrix.job.target }} in *-pc-windows-*) PKG_suffix=".zip" ;; esac; | |
| PKG_BASENAME=${PROJECT_NAME}-v${PROJECT_VERSION}-${{ matrix.job.target }} | |
| PKG_NAME=${PKG_BASENAME}${PKG_suffix} | |
| echo ::set-output name=PKG_NAME::${PKG_NAME} | |
| PKG_STAGING="${{ env.CICD_INTERMEDIATES_DIR }}/package" | |
| ARCHIVE_DIR="${PKG_STAGING}/${PKG_BASENAME}/" | |
| mkdir -p "${ARCHIVE_DIR}" | |
| mkdir -p "${ARCHIVE_DIR}/autocomplete" | |
| # Binary | |
| cp "${{ steps.strip.outputs.BIN_PATH }}" "$ARCHIVE_DIR" | |
| # Man page | |
| # cp 'doc/${{ env.PROJECT_NAME }}.1' "$ARCHIVE_DIR" | |
| # README, LICENSE and CHANGELOG files | |
| cp "README.md" "LICENSE" "CHANGELOG.md" "$ARCHIVE_DIR" | |
| # Autocompletion files | |
| # cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'*/out/'${{ env.PROJECT_NAME }}.bash' "$ARCHIVE_DIR/autocomplete/" | |
| # cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'*/out/'${{ env.PROJECT_NAME }}.fish' "$ARCHIVE_DIR/autocomplete/" | |
| # cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'*/out/'_${{ env.PROJECT_NAME }}.ps1' "$ARCHIVE_DIR/autocomplete/" | |
| # cp 'contrib/completion/_fd' "$ARCHIVE_DIR/autocomplete/" | |
| # base compressed package | |
| pushd "${PKG_STAGING}/" >/dev/null | |
| case ${{ matrix.job.target }} in | |
| *-pc-windows-*) 7z -y a "${PKG_NAME}" "${PKG_BASENAME}"/* | tail -2 ;; | |
| *) tar czf "${PKG_NAME}" "${PKG_BASENAME}"/* ;; | |
| esac; | |
| popd >/dev/null | |
| # Let subsequent steps know where to find the compressed package | |
| echo ::set-output name=PKG_PATH::"${PKG_STAGING}/${PKG_NAME}" | |
| - name: Check for release | |
| id: is-release | |
| shell: bash | |
| run: | | |
| unset IS_RELEASE ; if [[ $GITHUB_REF =~ ^refs/tags/v[0-9].* ]]; then IS_RELEASE='true' ; fi | |
| echo ::set-output name=IS_RELEASE::${IS_RELEASE} | |
| - name: Publish archives and packages | |
| uses: softprops/action-gh-release@v1 | |
| if: steps.is-release.outputs.IS_RELEASE | |
| with: | |
| body_path: CHANGELOG.md | |
| files: | | |
| ${{ steps.package.outputs.PKG_PATH }} | |
| # ${{ steps.debian-package.outputs.DPKG_PATH }} | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |