markdown_lint.yml

# Copyright 2023 The StableHLO 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
#
#      https://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: Markdown Lint

on:
  pull_request:
    branches: [ main ]
  push:
    branches: [ main ]
  schedule:
    # Run once a day
    - cron:  '0 12 * * *'
  workflow_dispatch:

jobs:
  markdown-lint:
    runs-on: ${{ github.repository == 'openxla/stablehlo' && 'ubuntu-22.04-64core' ||  'ubuntu-22.04'  }}
    steps:
    - name: Checking out repository
      uses: actions/checkout@v4
    - name: Running markdownlint
      run: |
        ./build_tools/github_actions/lint_markdown.sh --ignore "./docs/generated/**/*.md" "./**/*.md"