Skip to content

Publish Documentation #53

Publish Documentation

Publish Documentation #53

Workflow file for this run

name: Publish Documentation
on:
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
actions: read
concurrency:
group: 'pages'
cancel-in-progress: true
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v5
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '22'
cache: 'npm'
- name: Install Node.js dependencies
run: npm ci
- name: Generate OpenAPI documentation
run: |
npm run generate-docs
- name: Copy changelog and generate version info
run: |
# Generate version info JSON
echo "{\"version\": \"${{ github.event.release.tag_name }}\", \"release_date\": \"$(date -u +%Y-%m-%dT%H:%M:%SZ)\", \"release_url\": \"${{ github.event.release.html_url }}\"}" > docs/version.json
# Append real changelog content to the Jekyll template
echo "" >> docs/changelog.md
echo "---" >> docs/changelog.md
echo "" >> docs/changelog.md
tail -n +1 CHANGELOG.md >> docs/changelog.md
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1'
bundler-cache: true
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Build with Jekyll
run: |
bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
env:
JEKYLL_ENV: production
- name: Upload artifact
uses: actions/upload-pages-artifact@v4
with:
path: _site
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4