diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml new file mode 100644 index 000000000..38f14e32d --- /dev/null +++ b/.github/workflows/build-docs.yml @@ -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 + diff --git a/.github/workflows/yardoc.yml b/.github/workflows/yardoc.yml deleted file mode 100644 index f0c10756f..000000000 --- a/.github/workflows/yardoc.yml +++ /dev/null @@ -1,44 +0,0 @@ -# Taken from: https://github.com/marketplace/actions/deploy-yard-to-pages - -name: Deploy API docs to GitHub Pages -on: - push: - branches: ['main'] - paths: - - '.github/workflows/pages.yml' - - '.yardopts' - - 'lib/**' - - '**.gemspec' - - 'Gemfile' - - '**.md' - - '**.txt' - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -permissions: - contents: read - pages: write - id-token: write - -# Allow one concurrent deployment -concurrency: - group: 'pages' - 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 }} - runs-on: ubuntu-latest - name: Build and deploy YARD - steps: - - uses: kachick/deploy-yard-to-pages@v1.3.0 - id: deployment - # with: - # # default `doc` as default of `.yardopts` - # output-dir: 'docs' - # # default version is 3.2 - # ruby-version: '3.2' -