diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..1c7caab1 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +# Required for all files +* @estk @gadunga + diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 35f9e752..a812a4c1 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,123 +1,123 @@ name: CI on: - push: - branches: - - master - - devel - pull_request: - branches: - - master - - devel + push: + branches: + - main + - devel + pull_request: + branches: + - main + - devel jobs: - rust-lint: - name: Lint - runs-on: ubuntu-latest - steps: - - name: Checkout the source code - uses: actions/checkout@master - - - name: Install Rust stable - run: | - rustup toolchain update --no-self-update stable - rustup default stable - rustup component add clippy rustfmt - - - name: Run rustfmt - run: cargo fmt -- --check - - - name: Run clippy - run: cargo clippy --all-features - env: - RUSTFLAGS: -D warnings - - test: - name: Test - runs-on: ${{ matrix.os }} - strategy: - matrix: - rust_versions: ["stable", "1.67"] - os: [ubuntu-latest, windows-latest] - steps: - - name: Checkout the source code - uses: actions/checkout@master - - - name: Install Rust Versions - run: | - rustup toolchain install --no-self-update ${{ matrix.rust_versions }} - rustup default stable - - - name: Build lib - run: rustup run ${{ matrix.rust_versions }} cargo build ${{ matrix.cargo_build_flags }} - - - name: test lib - run: cargo test --all-features - env: - RUSTFLAGS: -D warnings - - features: - name: Test Individual Features - runs-on: ubuntu-latest - steps: - - name: Checkout the source code - uses: actions/checkout@master - - - name: Install Rust toolchain and jq - run: | - rustup toolchain install --no-self-update stable - rustup default stable - sudo apt-get install -y --no-install-recommends jq - - - name: Test lib - run: | - for feature in $(cargo read-manifest | jq -r '.features|keys|join("\n")'); do - echo building with feature "$feature" - RUSTFLAGS='-D warnings' cargo test --no-default-features --features "$feature" - done - - bench: - name: Benchmark the background_rotation feature - runs-on: ubuntu-latest - strategy: - matrix: - rust_versions: ["stable", "1.67"] - steps: - - name: Checkout the source code - uses: actions/checkout@master - - - name: Install Rust toolchain - run: | - rustup toolchain install --no-self-update stable - rustup default stable - - - name: Rotation with backgrounded rotation - run: cargo bench --features gzip,background_rotation - - cargo-audit: - name: Audit the baseline for CVEs - runs-on: ubuntu-latest - steps: - - name: Checkout the source code - uses: actions/checkout@master - - - name: Install Rust toolchain - run: | - rustup toolchain install --no-self-update stable - rustup default stable - - - name: Install Auditting Tools - run: cargo install cargo-audit - - - name: Audit project - run: cargo audit - - docs-lint: - name: Lint - runs-on: ubuntu-latest - steps: - - name: Markdown Linting Action - uses: avto-dev/markdown-lint@v1.5.0 - with: - config: .markdownlint.yml - args: docs/Configuration.md README.md + rust-lint: + name: Lint + runs-on: ubuntu-latest + steps: + - name: Checkout the source code + uses: actions/checkout@v4 + + - name: Install Rust stable + run: | + rustup toolchain update --no-self-update stable + rustup default stable + rustup component add clippy rustfmt + + - name: Run rustfmt + run: cargo fmt -- --check + + - name: Run clippy + run: cargo clippy --all-features + env: + RUSTFLAGS: -D warnings + + test: + name: Test + runs-on: ${{ matrix.os }} + strategy: + matrix: + rust_versions: ["stable", "1.67"] + os: [ubuntu-latest, windows-latest] + steps: + - name: Checkout the source code + uses: actions/checkout@v4 + + - name: Install Rust Versions + run: | + rustup toolchain install --no-self-update ${{ matrix.rust_versions }} + rustup default stable + + - name: Build lib + run: rustup run ${{ matrix.rust_versions }} cargo build ${{ matrix.cargo_build_flags }} + + - name: test lib + run: cargo test --all-features + env: + RUSTFLAGS: -D warnings + + features: + name: Test Individual Features + runs-on: ubuntu-latest + steps: + - name: Checkout the source code + uses: actions/checkout@v4 + + - name: Install Rust toolchain and jq + run: | + rustup toolchain install --no-self-update stable + rustup default stable + sudo apt-get install -y --no-install-recommends jq + + - name: Test lib + run: | + for feature in $(cargo read-manifest | jq -r '.features|keys|join("\n")'); do + echo building with feature "$feature" + RUSTFLAGS='-D warnings' cargo test --no-default-features --features "$feature" + done + + bench: + name: Benchmark the background_rotation feature + runs-on: ubuntu-latest + strategy: + matrix: + rust_versions: ["stable", "1.67"] + steps: + - name: Checkout the source code + uses: actions/checkout@v4 + + - name: Install Rust toolchain + run: | + rustup toolchain install --no-self-update stable + rustup default stable + + - name: Rotation with backgrounded rotation + run: cargo bench --features gzip,background_rotation + + cargo-audit: + name: Audit the baseline for CVEs + runs-on: ubuntu-latest + steps: + - name: Checkout the source code + uses: actions/checkout@v4 + + - name: Install Rust toolchain + run: | + rustup toolchain install --no-self-update stable + rustup default stable + + - name: Install Auditting Tools + run: cargo install cargo-audit + + - name: Audit project + run: cargo audit + + docs-lint: + name: Lint + runs-on: ubuntu-latest + steps: + - name: Markdown Linting Action + uses: avto-dev/markdown-lint@v1.5.0 + with: + config: .markdownlint.yml + args: docs/Configuration.md README.md diff --git a/docs/Configuration.md b/docs/Configuration.md index 50b208a5..c0a8d8a6 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -10,7 +10,7 @@ The `init_file` function takes the path to a config file as well as a objects specified by the config file. The following section covers the exact configuration syntax. Examples of both the programatic and configuration files can be found in the -[examples directory](https://github.com/estk/log4rs/tree/master/examples). +[examples directory](https://github.com/estk/log4rs/tree/main/examples). ## Common Fields diff --git a/src/lib.rs b/src/lib.rs index cbe8a687..ecd7e354 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -172,7 +172,7 @@ //! # fn main() {} //! ``` //! -//! For more examples see the [examples](https://github.com/estk/log4rs/tree/master/examples). +//! For more examples see the [examples](https://github.com/estk/log4rs/tree/main/examples). //! #![allow(where_clauses_object_safety, clippy::manual_non_exhaustive)]