Lint with Trunk.io (#14)

* use trunk * install deps * use string * use setup-just * add extra trunk inputs * fix trunk inputs * upload failure logs * fix artifact name * no need to upload * test with no arguments * add back arguments * use dev not deps
trailofbits · Feb 17, 2023 · e08a803 · e08a803
1 parent eec68b9
commit e08a803
Showing 1 changed file with 21 additions and 144 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -2,166 +2,43 @@ on:
   workflow_call:
     inputs:
       type:
-        description: "the expected lint entrypoint (derived from language by default)"
-        default: ""
+        description: "Use make or just to install project dependencies"
         required: false
         type: string
-      language:
-        description: "the language to configure"
-        required: true
-        type: string
-      directory:
-        description: "the directory to run the lint in"
-        required: false
-        type: string
-        default: "."
-      continue-on-error:
-        description: "don't mark the job as failed if a lint fails"
-        default: false
-        required: false
-        type: boolean
-      python-version:
-        description: "the version of Python to configure, if any (can be SemVer-formatted)"
-        default: ""
-        required: false
-        type: string
-      go-version:
-        description: "the Go version"
-        default: ""
-        required: false
-        type: string
-      golangci-lint-version:
-        description: "the golangci-lint version for Go linting"
-        default: "v1.50.1"
+      trunk-arguments:
+        description: Extra arguments to pass to trunk
         required: false
         type: string
-      cargo-sort:
-        description: "run cargo-sort as part of Rust linting"
-        default: false
-        required: false
-        type: boolean
-      org-repo-ref:
-        description: "the ref: branch or commit to use of the org repo"
-        default: "main"
+      trunk-check-mode:
+        description: "Trunk check mode. Leave unset to autodetect changes. Set to 'all' to check the entire repository."
         required: false
         type: string
 
-env:
-  # Rust: GitHub Actions supports color codes, so always enable them.
-  CARGO_TERM_COLOR: always
-
-  # Python: Tell ruff that we're in GitHub Actions, so that it emits annotations.
-  RUFF_FORMAT: github
-
-  # Python: Make-based linting workflows use `INSTALL_EXTRA` to optimize
-  # the subset of development dependencies installed.
-  INSTALL_EXTRA: lint
-
-  ORG_REPO: trailofbits/.github
-  ORG_REPO_REF: ${{ inputs.org-repo-ref }}
-
 jobs:
   lint:
+    name: Lint
     runs-on: ubuntu-latest
+
     steps:
       - uses: actions/checkout@v3
 
-      # Python
-      - name: configure python, if required
-        if: inputs.language == 'python'
-        uses: actions/setup-python@v4
-        with:
-          python-version: "${{ inputs.python-version }}"
-          python-version-file: "${{ inputs.directory }}/.python-version"
-          cache: pip
-          cache-dependency-path: |
-            **/pyproject.toml
-            **/requirements*.txt
-
-      # Rust
-      - name: configure rust and clippy, if required
-        if: inputs.language == 'rust'
-        continue-on-error: ${{ inputs.continue-on-error }}
-        working-directory: "${{ inputs.directory }}"
-        run: |
-          # we always run the latest stable Rust and Clippy for Rust linting.
-          rustup update
-          rustup component add clippy
-
-      - name: run rustfmt (rust)
-        if: inputs.language == 'rust' && inputs.type == ''
-        continue-on-error: ${{ inputs.continue-on-error }}
-        working-directory: "${{ inputs.directory }}"
-        run: cargo fmt --check
-
-      - name: run clippy (rust)
-        # NOTE: This is a fork of the original `actions-rs/clippy-check`,
-        # which is no longer maintained; the commit is pinned since no release
-        # has been made and its long term maintenance status/ownership is unclear.
-        if: inputs.language == 'rust' && inputs.type == ''
-        continue-on-error: ${{ inputs.continue-on-error }}
-        uses: actions-rs-plus/clippy-check@5eb300cdebee2681ff8513b9348b0ca793d8a293
-        with:
-          args: --all-features -- -D warnings
-          working-directory: "${{ inputs.directory }}"
-
-      - name: run cargo sort (rust)
-        if: inputs.language == 'rust' && inputs.type == ''
-        continue-on-error: ${{ inputs.continue-on-error }}
-        working-directory: "${{ inputs.directory }}"
-        run: |
-          cargo install cargo-sort
-          cargo sort -c
-
-      # Go
-      - name: configure go, if required
-        if: inputs.language == 'go'
-        continue-on-error: ${{ inputs.continue-on-error }}
-        uses: actions/setup-go@v3
+      - name: install just, if required
+        if: inputs.type == 'just'
+        uses: extractions/setup-just@95b912dc5d3ed106a72907f2f9b91e76d60bdb76 # pin@v1
         with:
-          go-version-file: "${{ inputs.directory }}/go.mod"
-          go-version: "${{ inputs.go-version }}"
+          just-version: '1.13.0'
 
-      - name: run golangci-lint (go)
-        if: inputs.language == 'go' && inputs.type == ''
-        continue-on-error: ${{ inputs.continue-on-error }}
-        uses: golangci/golangci-lint-action@0ad9a0988b3973e851ab0a07adf248ec2e100376 # @v3.3.1
-        with:
-          version: "${{ inputs.golangci-lint-version }}"
-          working-directory: "${{ inputs.directory }}"
+      - name: install dependencies with make, if required
+        if: inputs.type == 'make'
+        run: make dev
 
-      # Markdown
-      - name: download markdownlint config
-        if: inputs.language == 'markdown'
-        run: |
-          curl \
-            https://raw.githubusercontent.com/${{ env.ORG_REPO }}/${{ env.ORG_REPO_REF }}/configs/default.markdownlint.jsonc \
-              > /tmp/default.markdownlint.jsonc
+      - name: install dependencies with just, if required
+        if: inputs.type == 'just'
+        run: just dev
 
-      - name: run markdownlint-cli2
-        if: inputs.language == 'markdown'
-        continue-on-error: ${{ inputs.continue-on-error }}
-        uses: DavidAnson/markdownlint-cli2-action@v9
+      - name: trunk check
+        uses: trunk-io/trunk-action@9cf65e08e822e9842fd9ef7ed2a2bd9092de0986 # pin@v1
         with:
-          command: config
-          globs: |
-            /tmp/default.markdownlint.jsonc
-            **/*.md
-
-      # Make
-      - name: run lint (make)
-        if: (inputs.language == 'python' && inputs.type == '') || inputs.type == 'make'
-        continue-on-error: ${{ inputs.continue-on-error }}
-        run: make lint
-        working-directory: "${{ inputs.directory }}"
+          check-mode: ${{ inputs.trunk-check-mode }}
+          arguments: ${{ inputs.trunk-arguments }}
 
-      # Just
-      - name: configure just, if required
-        if: inputs.type == 'just'
-        run: cargo install just
-
-      - name: run lint (just)
-        if: inputs.type == 'just'
-        continue-on-error: ${{ inputs.continue-on-error }}
-        run: just lint
-        working-directory: "${{ inputs.directory }}"