.github/workflows/lint.yml

# Copyright (c) 2020-2021 Project CHIP Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Lint Code Base
on:
    push:
    pull_request:
    workflow_dispatch:

concurrency:
    group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}
    cancel-in-progress: true

jobs:
  code-lints:
    runs-on: ubuntu-latest
    if: github.actor != 'restyled-io[bot]'

    steps:
      - uses: actions/checkout@v2
      - name: Check broken links
        # On-push disabled until the job can run fully green
        # At that point the step should be enabled.
        if: github.event_name == 'workflow_dispatch'
        uses: gaurav-nelson/github-action-markdown-link-check@v1

      # git grep exits with 0 if it finds a match, but we want
      # to fail (exit nonzero) on match.  And we wasnt to exclude this file,
      # to avoid our grep regexp matching itself.
      - name: Check for incorrect error use in VerifyOrExit
        run: |
          git grep -n "VerifyOrExit(.*, [A-Za-z]*_ERROR" -- './*' ':(exclude).github/workflows/lint.yml' && exit 1 || exit 0

      # Comments like '{{! ... }}' should be used in zap files
      - name: Do not allow TODO in generated files
        run: |
          git grep -n 'TODO:' -- ./zzz_generated './*/zap-generated/*' && exit 1 || exit 0