Skip to content

Commit

Permalink
add github pages publish flow
Browse files Browse the repository at this point in the history
  • Loading branch information
mmenanno committed Jan 24, 2024
1 parent e64be41 commit bc5fa38
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions .github/workflows/build_and_public_yard_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Build and Publish Yard Docs

on:
push:
branches: [ main ]
workflow_dispatch:

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

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

jobs:
build:
name: Build and Publish Yard Docs
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Set up Ruby
uses: ruby/setup-ruby@v1.165.1
with:
ruby-version: 3.3.0
bundler-cache: true

- name: Install YARD
run: gem install yard

- name: Generate docs
run: yard docs

- name: Setup Github Pages
uses: actions/configure-pages@v4

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

- name: Publish to Github Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit bc5fa38

Please sign in to comment.