Deploy API docs to GitHub Pages #1
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
| # 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/[email protected] | |
| id: deployment | |
| # with: | |
| # # default `doc` as default of `.yardopts` | |
| # output-dir: 'docs' | |
| # # default version is 3.2 | |
| # ruby-version: '3.2' | |