research-project-boilerplate/.github/workflows/lint.yml at 41baa8286f7fe2002e71350582ca7f804f8fb069 · sodascience/research-project-boilerplate · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
name: Lint

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  # detect which languages are present
  detect:
    runs-on: ubuntu-latest
    outputs:
      has-python: ${{ steps.check.outputs.has-python }}
      has-r: ${{ steps.check.outputs.has-r }}
    steps:
      - uses: actions/checkout@v4

      - name: Detect languages
        id: check
        run: |
          if find . -name "*.py" ! -path "./.git/*" | grep -q .; then
            echo "has-python=true" >> $GITHUB_OUTPUT
          else
            echo "has-python=false" >> $GITHUB_OUTPUT
          fi

          if find . \( -name "*.R" -o -name "*.Rmd" -o -name "*.r" -o -name "*.qmd" \) ! -path "./.git/*" | grep -q .; then
            echo "has-r=true" >> $GITHUB_OUTPUT
          else
            echo "has-r=false" >> $GITHUB_OUTPUT
          fi

  lint-python:
    needs: detect
    if: needs.detect.outputs.has-python == 'true'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: astral-sh/ruff-action@v3
        with:
          args: "check ."

  lint-r:
    needs: detect
    if: needs.detect.outputs.has-r == 'true'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: r-lib/actions/setup-r@v2
        with:
          use-public-rspm: true

      - name: Install lintr
        run: Rscript -e "install.packages('lintr', repos = 'https://cloud.r-project.org')"

      - name: Lint R files
        run: |
          Rscript -e "
            issues <- lintr::lint_dir('.', linters = list(
              lintr::object_usage_linter(),
              lintr::assignment_linter()
            ))
            if (length(issues) > 0) {
              print(issues)
              quit(status = 1)
            } else {
              message('No linting issues found.')
            }
          "