Skip to content

Add linters to CI

Add linters to CI #5

Workflow file for this run

# Copyright 2020 The Serverless Workflow Specification 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.
# This workflow will run a set of linters on all files in the repository
# to ensure consistent formatting and style. It uses the super-linter
# action, which is a combination of many linters and formatters.
#
# For more information, see:
# https://github.com/super-linter/super-linter/blob/main/README.md
---
name: Lint
on: # yamllint disable-line rule:truthy
push:
branches: ["main"]
paths:
- "**/*.md"
- "**/*.yaml"
pull_request:
branches: ["main"]
paths:
- "**/*.md"
- "**/*.yaml"
jobs:
lint:
runs-on: ubuntu-latest
permissions:
contents: read
packages: read
# To report GitHub Actions status checks
statuses: write
steps:
- uses: actions/checkout@v4
with:
# super-linter needs the full git history to get the
# list of files that changed across commits
fetch-depth: 0
- uses: super-linter/super-linter@v6.5.1
env:
# To report GitHub Actions status checks
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# relative to $DEFAULT_WORKSPACE=$GITHUB_WORKSPACE
LINTER_RULES_PATH: "."
# check all files (including unmodified) in the repository
VALIDATE_ALL_CODEBASE: true
VALIDATE_MARKDOWN: true
MARKDOWN_CONFIG_FILE: .markdownlint.yaml
VALIDATE_YAML: true
YAML_CONFIG_FILE: .yamllint.yaml
VALIDATE_GHERKIN: true
VALIDATE_GITHUB_ACTIONS: true
VALIDATE_JSON: true