Skip to content

Commit

Permalink
Add documentation workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
floriandejonckheere committed Jul 28, 2024
1 parent 96774bc commit 2825bed
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Documentation

on:
push:
branches:
- master
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
name: Documentation

container:
image: ruby:${{ matrix.ruby }}-alpine

steps:
- uses: actions/checkout@v4

- name: Install dependencies
run: |
apk add build-base cmake git tar
- name: Cache Gems
uses: actions/[email protected]
with:
path: vendor/bundle
key: ${{ runner.os }}-${{ matrix.ruby }}-gem-${{ hashFiles('**/Gemfile.lock') }}
restore-keys: |
${{ runner.os }}-${{ matrix.ruby }}-gem-
- name: Install Gems
run: |
gem install bundler
bundle config path vendor/bundle
bundle install --jobs 4 --retry 3
- name: Setup Pages
uses: actions/configure-pages@v5

- name: Build YARD documentation
run: bundle exec yard doc

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: doc

- name: Deploy to GitHub Pages
uses: actions/deploy-pages@main

0 comments on commit 2825bed

Please sign in to comment.