* docs: publish community tools on website Mirror docs/COMMUNITY_TOOLS.md into Docusaurus so the Pages build publishes it for the default released docs and unreleased docs without relying on manual copy steps. Agent-Signature: codex-gpt-5.5-high on behalf of matt wilkie * docs: publish core support docs on website Mirror Sync Concepts, Labels, Metadata, Uninstalling, and Antivirus docs into Docusaurus and include them in the default released snapshot and LLM bundle. Clarify that agent execution and verification metadata are examples of metadata as a schema extension point, not native issue fields. Agent-Signature: codex-gpt-5.5-high on behalf of matt wilkie * docs: clarify metadata examples Replace local verification queue metadata with a tracker round-trip example so public metadata docs show upstream-aligned schema extension patterns. Agent-Signature: codex-gpt-5.5-high on behalf of matt wilkie ---------
102 lines
2.9 KiB
YAML
102 lines
2.9 KiB
YAML
name: Deploy Documentation
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- 'website/**'
|
|
- 'docs/ANTIVIRUS.md'
|
|
- 'docs/COMMUNITY_TOOLS.md'
|
|
- 'docs/LABELS.md'
|
|
- 'docs/METADATA.md'
|
|
- 'docs/SYNC_CONCEPTS.md'
|
|
- 'docs/UNINSTALLING.md'
|
|
- 'scripts/sync-website-docs.sh'
|
|
- 'scripts/generate-llms-full.sh'
|
|
workflow_dispatch:
|
|
|
|
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
# Allow only one concurrent deployment
|
|
concurrency:
|
|
group: "pages"
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
|
|
|
|
- name: Setup Node.js
|
|
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
|
|
with:
|
|
node-version: 24
|
|
cache: 'npm'
|
|
cache-dependency-path: website/package-lock.json
|
|
|
|
- name: Run website package gate
|
|
run: make ci-website
|
|
|
|
- name: Prepare link check (map baseUrl /beads/ to build output)
|
|
run: |
|
|
mkdir -p website/link-check-root
|
|
ln -s "$PWD/website/build" website/link-check-root/beads
|
|
|
|
- name: Check internal links
|
|
uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2
|
|
with:
|
|
args: |
|
|
--verbose
|
|
--no-progress
|
|
--offline
|
|
--include-fragments
|
|
--timeout 30
|
|
--root-dir website/link-check-root
|
|
--fallback-extensions html
|
|
--exclude-path 'website/build/search/**'
|
|
website/build
|
|
fail: true
|
|
|
|
- name: Check external links (non-blocking)
|
|
uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2
|
|
continue-on-error: true
|
|
with:
|
|
cache: true
|
|
args: |
|
|
--verbose
|
|
--no-progress
|
|
--timeout 30
|
|
--scheme https
|
|
--scheme http
|
|
--exclude 'localhost'
|
|
--exclude '127.0.0.1'
|
|
--exclude 'tree/main'
|
|
--exclude 'example.com'
|
|
--exclude 'mailto:'
|
|
--exclude-path 'website/build/search/**'
|
|
website/build
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5
|
|
with:
|
|
path: website/build
|
|
|
|
deploy:
|
|
# Guard: deploy should only run in the canonical repository (not in forks)
|
|
if: ${{ github.repository == 'gastownhall/beads' }}
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
runs-on: ubuntu-latest
|
|
needs: build
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5
|