dev.yml

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you 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: Dev
on:
  push:
    branches-ignore:
      - 'gh-readonly-queue/**'
  pull_request:
  merge_group:

permissions:
  contents: read

concurrency:
  group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }}
  cancel-in-progress: true

jobs:
  license-header-check:
    runs-on: ubuntu-latest
    name: Check License Header
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
      - name: Install HawkEye
      # This CI job is bound by installation time, use `--profile dev` to speed it up
        run: cargo install hawkeye --version 6.2.0 --locked --profile dev
      - name: Run license header check
        run: ci/scripts/license_header.sh

  prettier:
    name: Use prettier to check formatting of documents
    runs-on: ubuntu-slim
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
      - uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238  # v6.2.0
        with:
          node-version: "20"
      - name: Prettier check
      # if you encounter error, see instructions inside the script
        run: ci/scripts/doc_prettier_check.sh

  markdown-link-check:
    name: Check Markdown Links
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
      - name: Load tool versions
        run: |
          source ci/scripts/utils/tool_versions.sh
          echo "LYCHEE_VERSION=${LYCHEE_VERSION}" >> "$GITHUB_ENV"
      - name: Install lychee
        uses: taiki-e/install-action@055f5df8c3f65ea01cd41e9dc855becd88953486  # v2.75.18
        with:
          tool: lychee@${{ env.LYCHEE_VERSION }}
      - name: Run markdown link check
        run: bash ci/scripts/markdown_link_check.sh

  asf-yaml-check:
    name: Validate required_status_checks in .asf.yaml
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
      - run: pip install pyyaml
      - run: python3 ci/scripts/check_asf_yaml_status_checks.py

  typos:
    name: Spell Check with Typos
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
        with:
          persist-credentials: false
      # Version fixed on purpose. It uses heuristics to detect typos, so upgrading
      # it may cause checks to fail more often.
      # We can upgrade it manually once a while.
      - name: Install typos-cli
        run: cargo install typos-cli --locked --version 1.37.0
      - name: Run typos check
        run: ci/scripts/typos_check.sh