build-pb-doc.yml

name: build-pb-doc

on:
  push:
    branches: [main]
    paths:
      - "pb/tzinfo.proto"
      - ".github/workflows/build-pb-doc.yml"
  pull_request:
    branches: [main]
    paths:
      - "pb/tzinfo.proto"
      - ".github/workflows/build-pb-doc.yml"

permissions:
  contents: write
  deployments: write

jobs:
  build-doc:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Set up Go
        uses: actions/setup-go@v5
        with:
          go-version: 1.21

      - name: Install go pkgs
        run: |
          make install

      - name: Install pb pkgs
        run: |
          go install github.com/golang/protobuf/protoc-gen-go@latest
          go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest

      - name: Setup protoc
        uses: arduino/setup-protoc@v2.1.0

      - name: Build doc
        run: |
          make pb

      - name: Upload a Build Artifact
        uses: actions/upload-artifact@v3.1.3
        if: ${{ github.ref_name == 'main' }}
        with:
          name: "Probuf HTML File"
          path: "pb/pb.html"

  push-doc:
    needs: build-doc
    runs-on: ubuntu-latest
    if: ${{ github.ref_name == 'main' }}
    steps:
      - uses: actions/checkout@v4
        with:
          ref: gh-pages

      - name: Download a Build Artifact
        uses: actions/download-artifact@v4.0.0
        with:
          name: "Probuf HTML File"
          path: "./docs"

      - name: Push file update
        run: |
          git add ./docs/pb.html
          git config user.name github-actions
          git config user.email github-actions@github.com
          git commit -m "Update Probuf HTML doc"
          git push