Files
greptimedb/.github/workflows/docs.yml
T
dennis zhuang 00b2c57c0a docs: link the observability database definition from README (#10061)
* docs: link the observability database definition from README

Signed-off-by: Dennis Zhuang <killme2008@gmail.com>

* ci: add the new required checks to the Docs CI placeholders

The main ruleset now requires five more checks. Their workflows skip
docs-only PRs via paths-ignore, so without placeholders those PRs can
never satisfy the required checks.

Signed-off-by: Dennis Zhuang <killme2008@gmail.com>

---------

Signed-off-by: Dennis Zhuang <killme2008@gmail.com>
2026-10-31 15:38:08 +00:00

84 lines
2.3 KiB
YAML

on:
merge_group:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
paths:
- 'docs/**'
- 'config/**'
- '**.md'
- '.dockerignore'
- 'docker/**'
- '.gitignore'
- 'grafana/**'
- 'Makefile'
push:
branches:
- main
paths:
- 'docs/**'
- 'config/**'
- '**.md'
- '.dockerignore'
- 'docker/**'
- '.gitignore'
- 'grafana/**'
- 'Makefile'
workflow_dispatch:
inputs:
ci_command:
description: Internal comment-command marker
required: false
default: false
type: boolean
name: Docs CI
# To pass the required status check, see:
# https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks#handling-skipped-but-required-checks
jobs:
typos:
if: ${{ github.event_name != 'pull_request' || github.event.pull_request.draft == false || github.run_attempt > 1 }}
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
persist-credentials: false
- uses: crate-ci/typos@v1.50.2
license-header-check:
if: ${{ github.event_name != 'pull_request' || github.event.pull_request.draft == false || github.run_attempt > 1 }}
runs-on: ubuntu-latest
name: Check License Header
steps:
- uses: actions/checkout@v4
with:
persist-credentials: false
- uses: korandoru/hawkeye@v5
required-checks:
if: ${{ github.event_name != 'pull_request' || github.event.pull_request.draft == false || github.run_attempt > 1 }}
name: ${{ matrix.check }}
runs-on: ubuntu-slim
strategy:
matrix:
check:
- Check
- Rustfmt
- Clippy
- Unused Dependencies
- Sqlness Test (Basic)
- Sqlness Test (Remote WAL)
- test
- coverage
- Sqlness Test (Flat format)
- Compatibility Test (recent releases)
- GitHub Script Tests (Rust CI)
- GitHub Script Tests (Integration CI)
- Check for conflict
- Check Unused Dependencies
- Build GreptimeDB binaries (ubuntu-latest)
steps:
- run: 'echo "No action required"'