mirror of
https://github.com/zed-industries/zed.git
synced 2026-05-31 19:05:00 +07:00
64b93202f8
Self-Review Checklist: - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [ ] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) - [ ] Tests cover the new/changed behavior - [ ] Performance impact has been considered and is acceptable Release Notes: - N/A --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
46 lines
1.4 KiB
YAML
46 lines
1.4 KiB
YAML
name: "Build docs"
|
|
description: "Build the docs"
|
|
|
|
runs:
|
|
using: "composite"
|
|
steps:
|
|
- name: Setup mdBook
|
|
uses: peaceiris/actions-mdbook@ee69d230fe19748b7abf22df32acaa93833fad08 # v2
|
|
with:
|
|
mdbook-version: "0.4.37"
|
|
|
|
- name: Cache dependencies
|
|
uses: swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2
|
|
with:
|
|
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
# cache-provider: "buildjet"
|
|
|
|
- name: Install Linux dependencies
|
|
shell: bash -euxo pipefail {0}
|
|
run: ./script/linux
|
|
|
|
- name: Download WASI SDK
|
|
shell: bash -euxo pipefail {0}
|
|
run: ./script/download-wasi-sdk
|
|
|
|
- name: Generate action metadata
|
|
shell: bash -euxo pipefail {0}
|
|
run: ./script/generate-action-metadata
|
|
|
|
- name: Check for broken links (in MD)
|
|
uses: lycheeverse/lychee-action@82202e5e9c2f4ef1a55a3d02563e1cb6041e5332 # v2.4.1
|
|
with:
|
|
args: --no-progress --exclude '^http' './docs/src/**/*'
|
|
fail: true
|
|
|
|
- name: Build book
|
|
shell: bash -euxo pipefail {0}
|
|
run: |
|
|
mkdir -p target/deploy
|
|
mdbook build ./docs --dest-dir=../target/deploy/docs/
|
|
|
|
- name: Check for broken links (in HTML)
|
|
uses: lycheeverse/lychee-action@82202e5e9c2f4ef1a55a3d02563e1cb6041e5332 # v2.4.1
|
|
with:
|
|
args: --no-progress --exclude '^http' 'target/deploy/docs/'
|
|
fail: true
|