docs.yml

# This is a basic workflow to help you get started with Actions

name: Docs GH Pages

# Controls when the action will run. 
on:
  # Triggers the workflow on push or pull request events but only for the master branch
  push:
    branches: [ master ]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v2

      # Ensure has right go version
      - uses: actions/setup-go@v3
        with:
          go-version: '>=1.17.0'

      - name: Install Protoc
        uses: arduino/setup-protoc@v1

      - name: Install protoc-gen-doc
        run: go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
        
      - name: Build Docs
        run: |
          mkdir ./out
          protoc -I . --doc_out=./out --doc_opt=html,index.html ./OpenControllerLib.proto
        
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./out  # default: public