docs: add TOC to readme (#4949) #3996
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
on: | |
merge_group: | |
pull_request: | |
types: [opened, synchronize, reopened, ready_for_review] | |
paths: | |
- 'docs/**' | |
- 'config/**' | |
- '**.md' | |
- '.dockerignore' | |
- 'docker/**' | |
- '.gitignore' | |
- 'grafana/**' | |
push: | |
branches: | |
- main | |
paths: | |
- 'docs/**' | |
- 'config/**' | |
- '**.md' | |
- '.dockerignore' | |
- 'docker/**' | |
- '.gitignore' | |
- 'grafana/**' | |
workflow_dispatch: | |
name: 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: | |
name: Spell Check with Typos | |
runs-on: ubuntu-20.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: crate-ci/typos@master | |
license-header-check: | |
runs-on: ubuntu-20.04 | |
name: Check License Header | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: korandoru/hawkeye@v5 | |
check: | |
name: Check | |
runs-on: ubuntu-20.04 | |
steps: | |
- run: 'echo "No action required"' | |
fmt: | |
name: Rustfmt | |
runs-on: ubuntu-20.04 | |
steps: | |
- run: 'echo "No action required"' | |
clippy: | |
name: Clippy | |
runs-on: ubuntu-20.04 | |
steps: | |
- run: 'echo "No action required"' | |
coverage: | |
runs-on: ubuntu-20.04 | |
steps: | |
- run: 'echo "No action required"' | |
sqlness: | |
name: Sqlness Test (${{ matrix.mode.name }}) | |
runs-on: ${{ matrix.os }} | |
strategy: | |
matrix: | |
os: [ ubuntu-20.04 ] | |
mode: | |
- name: "Basic" | |
- name: "Remote WAL" | |
steps: | |
- run: 'echo "No action required"' |