Skip to content

Commit 30d191b

Browse files
committed
ci: add workflow for building API documentation
1 parent ba2865c commit 30d191b

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: documentation
2+
3+
on:
4+
workflow_dispatch:
5+
6+
permissions:
7+
contents: read
8+
pages: write
9+
id-token: write
10+
11+
concurrency:
12+
group: "pages"
13+
cancel-in-progress: false
14+
15+
jobs:
16+
deploy:
17+
environment:
18+
name: github-pages
19+
url: ${{ steps.deployment.outputs.page_url }}
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v6
24+
- name: Setup Ruby
25+
uses: actions/setup-ruby@v1
26+
with:
27+
ruby-version: 3.4
28+
bundler-cache: true
29+
- name: Build API documentation
30+
run: bundle exec yard doc -o output/doc
31+
- name: Upload API documentation
32+
uses: actions/upload-pages-artifact@v4
33+
with:
34+
path: output
35+
- name: Setup Pages
36+
uses: actions/configure-pages@v5
37+
- name: Deploy to GitHub Pages
38+
id: deployment
39+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)