docs: improve pre-commit docs and discoverability when CI fails #684
Workflow file for this run
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
name: Docs Testing | |
on: | |
pull_request: | |
paths: | |
- "docs/**" | |
types: [synchronize, opened, reopened, ready_for_review] | |
# cancel previous workflow jobs for PRs | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }} | |
cancel-in-progress: true | |
jobs: | |
linkinator: | |
# See docs here: https://github.com/marketplace/actions/linkinator | |
name: Link Checking | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: JustinBeckwith/[email protected] | |
with: | |
paths: "**/*.md, **/*.mdx" | |
linksToSkip: >- | |
^https://github.com/apache/(superset|incubator-superset)/(pull|issue)/\d+, | |
http://localhost:8088/, | |
docker/.env-non-dev, | |
http://127.0.0.1:3000/, | |
http://localhost:9001/, | |
https://charts.bitnami.com/bitnami, | |
https://www.li.me/, | |
https://www.fanatics.com/, | |
https://tails.com/gb/, | |
https://www.techaudit.info/, | |
https://avetilearning.com/, | |
https://www.udemy.com/, | |
https://trustmedis.com/, | |
http://theiconic.com.au/, | |
https://dev.mysql.com/doc/refman/5.7/en/innodb-limits.html, | |
^https://img\.shields\.io/.*, | |
https://vkusvill.ru/ | |
build-deploy: | |
name: Build & Deploy | |
runs-on: ubuntu-22.04 | |
defaults: | |
run: | |
working-directory: docs | |
steps: | |
- name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )" | |
uses: actions/checkout@v4 | |
with: | |
persist-credentials: false | |
submodules: recursive | |
- name: Set up Node.js 20 | |
uses: actions/setup-node@v4 | |
with: | |
node-version: '20' | |
- name: yarn install | |
run: | | |
yarn install --check-cache | |
- name: yarn typecheck | |
run: | | |
yarn typecheck | |
- name: yarn build | |
run: | | |
yarn build |