Skip to content

update ci labels and rewrite the README.md #36

update ci labels and rewrite the README.md

update ci labels and rewrite the README.md #36

Workflow file for this run

name: Deploy Docs
on:
push:
branches: [main]
paths:
- 'docs/**'
- 'docs-site/**'
- 'specs/**'
- 'scripts/generate-asyncapi-html.mjs'
- '.github/workflows/docs-deploy.yml'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: pnpm/action-setup@v6
- uses: actions/setup-node@v6
with:
node-version: '24'
cache: 'pnpm'
- name: Install dependencies
run: pnpm install --frozen-lockfile
- name: Generate AsyncAPI HTML bundles
run: pnpm docs:asyncapi
- name: Build manifest
run: node docs-site/scripts/build-manifest.mjs
- name: Build docs site
run: pnpm docs:build
- name: Merge TypeDoc /api/ from gh-pages
run: node docs-site/scripts/fetch-typedoc.mjs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/configure-pages@v5
- uses: actions/upload-pages-artifact@v3
with:
path: docs-site/dist
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v5