chore(backlog): add new task #1069
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
| ## | |
| # CD using GitHub Actions. | |
| # | |
| # NOTE: GitHub Actions DSL. | |
| # - https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions#understanding-the-workflow-file | |
| # - https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions | |
| # | |
| # NOTE: Ruby workflow example. | |
| # - https://github.com/ruby/setup-ruby#usage | |
| # | |
| # NOTE: How to set the working directory for the run directive (working-directory)? | |
| # - https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrunhttps://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun | |
| # | |
| # NOTE: How to deploy to GitHub Pages using GitHub Actions? | |
| # - https://github.com/marketplace/actions/github-pages-action | |
| # | |
| name: CD | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| deploy_api_docs: | |
| runs-on: ubuntu-20.04 | |
| name: Deploy API Docs | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Ruby | |
| uses: ruby/setup-ruby@v1 | |
| with: | |
| ruby-version: 3.2 | |
| ## | |
| # NOTE: Installs the latest compatible Bundler version, runs `bundle install` and caches installed gems. | |
| # - https://github.com/ruby/setup-ruby#usage | |
| # - https://github.com/ruby/setup-ruby#bundler | |
| # | |
| bundler-cache: true | |
| ## | |
| # NOTE: Installs Task (task runner). | |
| # - https://taskfile.dev/installation/#github-actions | |
| # - https://github.com/go-task/task | |
| # | |
| - name: Install Task (task runner) | |
| uses: arduino/setup-task@v1 | |
| - name: Generate docs | |
| working-directory: ./ | |
| run: task docs:generate | |
| - name: Deploy docs to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/api | |
| cname: apidocs.convenientservice.org | |
| create_github_release: | |
| runs-on: ubuntu-20.04 | |
| name: Create GitHub Release PR | |
| steps: | |
| - uses: google-github-actions/release-please-action@v3 | |
| with: | |
| changelog-path: CHANGELOG.md | |
| default-branch: main | |
| include-v-in-tag: true | |
| package-name: convenient_service | |
| release-type: ruby | |
| version-file: lib/convenient_service/version.rb |