Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Documentation

on:
pull_request:
paths:
- 'ccip-sdk/src/**'
- 'ccip-cli/src/**'
- 'ccip-api-ref/**'
- 'package.json'
- 'package-lock.json'
push:
branches:
- main
paths:
- 'ccip-sdk/src/**'
- 'ccip-cli/src/**'
- 'ccip-api-ref/**'

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 24
cache: 'npm'

- name: Install dependencies
run: npm ci

- name: Run checks
run: npm run check -w ccip-api-ref

- name: Generate API docs from OpenAPI spec
run: npm run gen-api -w ccip-api-ref

- name: Build documentation
run: npm run docs:build

- name: Upload build artifact
if: github.ref == 'refs/heads/main'
uses: actions/upload-artifact@v4
with:
name: docs-build
path: ccip-api-ref/build
retention-days: 7
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,19 @@ dist/
coverage-summary.txt
.coverage
.c8_output

# Vercel
.vercel/

# Docusaurus
.docusaurus/
build/
ccip-api-ref/docs-sdk/*
!ccip-api-ref/docs-sdk/introduction.mdx
!ccip-api-ref/docs-sdk/guides/
ccip-api-ref/docs-api/*
!ccip-api-ref/docs-api/ccip-api.info.mdx
!ccip-api-ref/docs-api/sidebar.d.ts.vercel
!ccip-api-ref/docs-api/v1/
ccip-api-ref/docs-api/v1/*
!ccip-api-ref/docs-api/v1/sidebar.d.ts
1 change: 1 addition & 0 deletions ccip-api-ref/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
static/llms.txt
9 changes: 9 additions & 0 deletions ccip-api-ref/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Generated directories
.docusaurus/
build/
docs-sdk/
docs-api/
test-results/

# Dependencies
node_modules/
Loading
Loading