Add documentation workflow #3
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
