Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API docs #1697

Merged
merged 12 commits into from
Oct 8, 2024
36 changes: 36 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Publish API docs

permissions:
pages: write
id-token: write

on:
release:
types: [published]
workflow_dispatch:

jobs:
docs:
name: Build and publish API docs
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
- name: Build API docs
run: |
npm ci
npm run docs -w langium
- name: Upload docs artifact
uses: actions/upload-pages-artifact@v3
with:
path: packages/langium/docs
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
.vscode-test/
coverage/
dist/
docs/
lib/
out/
node_modules/
Expand Down
Loading
Loading