docs.yml

name: docs

permissions: 
  contents: write

on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master

jobs:
  build:
    runs-on: ubuntu-latest
    env:
      DD_PROFILING_NO_EXTENSION: true

    steps:
      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
        with:
          # Fetch all history for applying timestamps to every page
          fetch-depth: 0

      - name: Set up Ruby
        uses: ruby/setup-ruby@dffb23f65a78bba8db45d387d5ea1bbd6be3ef18 # v1.293.0
        with:
          ruby-version: "2.7"
          bundler-cache: true
          # modify repository secret when there are problems with installing gems
          cache-version: ${{ secrets.CACHE_VERSION }}

      - name: Cache yardoc
        uses: actions/cache@6f8efc29b200d32929f49075959781ed54ec270c # v3.5.0
        with:
          path: |
            .yardoc
            doc
          key: yardoc

      - name: Install
        run: bundler install

      - name: Build documentation
        run: bundler exec rake docs

      - name: Compress docs
        run: tar czf doc.tar.gz doc

      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
        with:
          name: documentation
          path: doc.tar.gz

  publish:
    runs-on: ubuntu-latest

    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
    needs:
      - build

    steps:
      - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
        with:
          name: documentation
          path: doc

      - name: Uncompress docs
        run: tar xzf doc/doc.tar.gz && rm doc/doc.tar.gz

      - uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3.9.3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./doc
          commit_message: ${{ github.event.head_commit.message }}
          # Write .nojekyll at the root, see:
          # https://help.github.com/en/github/working-with-github-pages/about-github-pages#static-site-generators
          enable_jekyll: false
          # Only deploy if there were changes
          allow_empty_commit: false
          # GH pages branch is getting super big, so we want to reduce it by creating an orphan branch
          force_orphan: true