flagon-io/hello

public

Greets people from the command line. The sample repository for g1t.

Add CI: formatting, lints and tests on every pull request #78

Closedsyntaqx opened this 4d agochore

Resolved by Add CI: formatting, lints and tests on every pull request #79, merged by g1t 4d ago

Add continuous integration as a GitHub Actions workflow at .g1t/workflows/ci.yml (g1t runs GitHub Actions workflows from .g1t/workflows), with exactly this content:

name: CI
on:
  push:
    branches: [main]
  pull_request:
  merge_group:
jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt, clippy
      - uses: actions/cache@v6
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: cargo-${{ runner.os }}-${{ hashFiles('Cargo.lock') }}
          restore-keys: cargo-${{ runner.os }}-
      - name: Formatting
        run: cargo fmt --check
      - name: Lints
        run: cargo clippy --all-targets -- -D warnings
      - name: Tests
        run: cargo test

yaml

The code is not formatted with cargo fmt today, so the Formatting step would fail: run cargo fmt in the same change. Add a line to the README saying that every pull request runs formatting, lints and tests.

Pull requests

1 for this issue

Add CI: formatting, lints and tests on every pull request #795 files+58−96d3fd454d ago
Merged by g1t·g1t· requested by syntaqx
I added the CI workflow at .g1t/workflows/ci.yml with the exact content from the issue. It runs cargo fmt --check, cargo clippy --all-targets -- -D warnings and cargo test on pushes to main, pull requests and merge groups. The README's Develop section now says every pull request runs formatting, lints and tests. I also ran cargo fmt so the Formatting step passes. It changed src/lib.rs, src/main.rs and tests/cli.rs, and the changes are formatting only. #7 and #8 both edit src/lib.rs and src/main.rs, and #7 edits the README, so whichever merges second may hit small conflicts in the lines cargo fmt touched. I did not message either pull request about this. If #7 or #8 adds code that isn't formatted, the Formatting step will fail on it until they run cargo fmt. I ran cargo clippy --all-targets -- -D warnings locally and it is clean. cargo test passes, and I did not run cargo fmt --check as a separate step after formatting. I have not seen the workflow run on g1t, so I haven't confirmed the action versions in the file (actions/checkout@v7, actions/cache@v6) resolve there.

Discussion

syntaqxassigned this to g1t, which opened #79· 4d ago

g1tbotclosed this by merging #79· 4d ago