blockwatch 0.5.3

Language agnostic linter that keeps your code and documentation in sync and valid
Documentation 
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

name: blockwatch

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

permissions:
  contents: read

jobs:
  blockwatch:
    runs-on: ubuntu-latest
    env:
      # A run is "trusted" when it is a push (which requires write access) or a pull request whose
      # branch lives in this repository (i.e. not a fork). Only trusted runs may execute Lua scripts
      # in `safe` mode (which exposes `io`/`os`) and receive the API key, since `check-lua` scripts
      # come from the scanned files and would otherwise let a fork PR run arbitrary commands.
      TRUSTED: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository }}

    steps:
      - uses: mennanov/blockwatch-action@v1
        env:
          # Untrusted (fork) PRs are still linted, but only in the sandboxed mode (no file/OS access)
          # and without any secrets.
          BLOCKWATCH_LUA_MODE: ${{ env.TRUSTED == 'true' && 'safe' || 'sandboxed' }}
          BLOCKWATCH_AI_API_KEY: ${{ env.TRUSTED == 'true' && secrets.BLOCKWATCH_AI_API_KEY || '' }}
        with:
          ignore: "tests/testdata/**"