Skip to content

Commit

Permalink
Merge pull request #279 from scarpe-team/disable_yardoc_ghaction
Browse files Browse the repository at this point in the history
Fix non-working yardoc flow
  • Loading branch information
Schwad authored Jul 10, 2023
2 parents 1f7af1b + 5fbe4cf commit fe6dcf0
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 44 deletions.
63 changes: 63 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Based on https://raw.githubusercontent.com/actions/starter-workflows/main/pages/jekyll.yml

name: Deploy YARD documentation to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: [$default-branch]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install dependencies
run: sudo apt-get -y install portaudio19-dev libgtk-3-dev libwebkit2gtk-4.0-dev
- name: Setup Ruby
uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
with:
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
cache-version: 0 # Increment this number if you need to re-download cached gems
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
- name: Build with yardoc
run: bundle exec yardoc -o docs
env:
FAKE_ENV: example
- name: Upload artifact
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v1
with:
path: ./docs

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

44 changes: 0 additions & 44 deletions .github/workflows/yardoc.yml

This file was deleted.

0 comments on commit fe6dcf0

Please sign in to comment.