Skip to content

docs: Channel initiation and API calls tests with Python #2347

docs: Channel initiation and API calls tests with Python

docs: Channel initiation and API calls tests with Python #2347

name: Validate Docs Generation
on:
pull_request:
branches:
- main
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
generate-docs:
name: Generate Docs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
- run: npm i -g pnpm @antfu/ni
- name: Setup Node
uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4
with:
node-version: 18
cache: pnpm
cache-dependency-path: .docs/pnpm-lock.yaml
- name: Install dependencies
run: cd .docs && nci
- name: Use NODE_ENV=production
run: echo "NODE_ENV=production" >> $GITHUB_ENV
- name: Static HTML export with Nuxt
run: cd .docs && nr generate
lint-markdown:
name: Lint Markdown
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
- run: npm i -g pnpm @antfu/ni
- uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4
with:
node-version: 18
cache: pnpm
cache-dependency-path: .docs/pnpm-lock.yaml
- run: cd .docs && nci
- run: cd .docs && nr lint:md
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
- run: npm i -g pnpm @antfu/ni
- uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4
with:
node-version: 18
cache: pnpm
cache-dependency-path: .docs/pnpm-lock.yaml
- run: cd .docs && nci
- run: cd .docs && nr lint