A simple linter + pull request flow for GitHub Actions

Instructions.md

• Add lint.yml under .github/workflows/
• Add the swiftlint stub under bin/
• Don't forget to chmod +x bin/swiftlint

lint.yml

name: lint

on:
  pull_request:
  push:
    branches: [ master ]

jobs:
  lint-swift:
    if: ${{ !startsWith(github.head_ref, 'dependabot/') }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Lint
        run: bin/swiftlint --fix .

      - name: Create Pull Request
        uses: peter-evans/create-pull-request@v6
        with:
          title: "[lint] Fix SwiftLint issues in #${{ github.event.pull_request.number }}"
          base: ${{ github.head_ref }}
          branch: ci-lint/swift/${{ github.ref_name }}
          body: |
            Here are some helpful linter fixes for your swift code in #${{ github.event.pull_request.number }}

swiftlint

#!/usr/bin/env bash

if [[ -z "${CI}" ]]; then
  echo "Running locally"
else
  echo "Running in CI"
  function swiftlint() {
    docker run --rm -v "$(pwd):/workdir" --workdir /workdir ghcr.io/realm/swiftlint:latest swiftlint "$@"
  }
fi

swiftlint $@