Skip to content

Commit

Permalink
Refactor publishing of yard docs (#2017)
Browse files Browse the repository at this point in the history
  • Loading branch information
bess authored Jan 23, 2025
1 parent 1832082 commit 7a58426
Showing 1 changed file with 9 additions and 19 deletions.
28 changes: 9 additions & 19 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,6 @@ name: Deploy API docs to GitHub Pages
on:
push:
branches: ["main"]
# paths:
# - '.github/workflows/pages.yml'
# - '.yardopts'
# - 'lib/**'
# - 'Gemfile'
# - '**.txt'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

permissions:
Expand All @@ -23,18 +16,15 @@ concurrency:
cancel-in-progress: true

jobs:
deploy_yard:
# the deploy environment (not to be confused with env)
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
build:
runs-on: ubuntu-latest
name: Build and deploy YARD
steps:
- uses: kachick/deploy-yard-to-pages@v1.3.0
id: deployment
- uses: actions/checkout@v4
- uses: ruby/setup-ruby@v1
with:
# default `doc` as default of `.yardopts`
# output-dir: 'doc'
# default version is 3.2
ruby-version: "3.2"
bundler-cache: true
- run: bundle exec yard doc
- uses: actions/upload-pages-artifact@v3
with:
path: doc/
- uses: actions/deploy-pages@v4

0 comments on commit 7a58426

Please sign in to comment.