docs.yml

name: Documentation

on:
  pull_request:
    types:
      - closed
    branches:
      - main
      - test-docs-generator # for testing

permissions:
  contents: read

jobs:
  update:
    name: Update
    if: github.event.pull_request.merged == true
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
    steps:
      - name: Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: Setup Go
        uses: actions/setup-go@4b73464bb391d4059bd26b0524d20df3927bd417 # v6.3.0
        with:
          go-version-file: 'go.mod'
      - name: Generate documentation
        run: make docs
      - name: Create PR for docs update
        uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0
        with:
          add-paths: docs/
          branch: chore/update-docs
          commit-message: "chore(docs): update documentation for #${{ github.event.number }}"
          committer: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
          reviewers: ${{ github.actor }}
          title: Update documentation
          body: "This is an automatically created PR. Changes were created by running `make docs` after merging #${{ github.event.number }} (${{ github.sha }})."
          base: ${{ github.event.pull_request.base.ref }}