From c3ade3a2723dea4d2a3a331fc3e50cb3dd6f7ffb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20M=C3=BCller?= Date: Wed, 18 Sep 2024 06:10:47 +0200 Subject: [PATCH] Introduce GitHub Action based CI This change adds a configuration file for a GitHub Actions based CI pipeline to the repository. This file (directly or indirectly) controls the environment in which to build and test, and is also used for some additional linting. With the pipeline in place the change also adds a badge indicating the status of the build on the project's front page. --- .github/workflows/test.yml | 54 ++++++++++++++++++++++++++++++++++++++ .rustfmt.toml | 9 +++++++ CHANGELOG.md | 6 +++++ README.md | 3 +++ 4 files changed, 72 insertions(+) create mode 100644 .github/workflows/test.yml create mode 100644 .rustfmt.toml diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..5dfc58b --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,54 @@ +# Copyright (C) 2024 Daniel Mueller +# SPDX-License-Identifier: GPL-3.0-or-later + +name: Test + +on: + pull_request: + push: + +env: + CARGO_TERM_COLOR: always + RUST_BACKTRACE: 1 + # Build without debug information enabled to decrease compilation time + # and binary sizes in CI. This option is assumed to only have marginal + # effects on the generated code, likely only in terms of section + # arrangement. See + # https://doc.rust-lang.org/cargo/reference/environment-variables.html + # https://doc.rust-lang.org/rustc/codegen-options/index.html#debuginfo + RUSTFLAGS: '-C debuginfo=0' + +jobs: + test: + name: Build and test [${{ matrix.rust }}, ${{ matrix.profile }}] + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + rust: [stable] + profile: [dev, release] + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@master + with: + toolchain: ${{ matrix.rust }} + - name: Build & test ${{ matrix.profile }} + run: | + cargo build --profile=${{ matrix.profile }} --all-features --bins --tests + cargo test --profile=${{ matrix.profile }} --all-features + clippy: + name: Lint with clippy + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + - run: cargo clippy --no-deps --all-targets --all-features --tests -- -A unknown_lints -A deprecated -D warnings + rustfmt: + name: Check code formatting + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@nightly + with: + components: rustfmt + - run: cargo +nightly fmt -- --check diff --git a/.rustfmt.toml b/.rustfmt.toml new file mode 100644 index 0000000..4f2419e --- /dev/null +++ b/.rustfmt.toml @@ -0,0 +1,9 @@ +# Copyright (C) 2024 Daniel Mueller +# SPDX-License-Identifier: CC0-1.0 + +blank_lines_lower_bound = 0 +blank_lines_upper_bound = 2 +edition = "2021" +match_block_trailing_comma = true +tab_spaces = 2 +trailing_semicolon = false diff --git a/CHANGELOG.md b/CHANGELOG.md index e363844..1a250e2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +Unreleased +---------- +- Removed unused `once_cell` and `regex` dependencies +- Added GitHub Actions based CI workflow + + 0.1.1 ----- - Factored out diff parsing functionality into `diff-parse` crate diff --git a/README.md b/README.md index 6504e51..68049cf 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +[![pipeline](https://github.com/d-e-s-o/git-blamediff/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/d-e-s-o/git-blamediff/actions/workflows/test.yml) +[![crates.io](https://img.shields.io/crates/v/git-blamediff.svg)](https://crates.io/crates/git-blamediff) + git-blamediff =============