godoc.yml

name: Print Go API changes

on:
  workflow_call:
    secrets:
      ORG_GH_TOKEN:
        required: true
    inputs:
      go-version:
        type: string
        default: "1.19"

env:
  GOPRIVATE: github.com/TykTechnologies

jobs:
  test:
    name: Detect Go API changes
    runs-on: ubuntu-latest

    steps:
      - name: Use GitHub Token
        env:
          TOKEN: ${{ secrets.ORG_GH_TOKEN }}
        run: >
          git config --global url."https://${TOKEN}@github.com".insteadOf "https://github.com"

      - name: Checkout repo
        uses: TykTechnologies/github-actions/.github/actions/checkout-pr@main
        with:
          token: ${{ secrets.ORG_GH_TOKEN }}

      - name: Checkout exp
        uses: actions/checkout@v3
        with:
          fetch-depth: 1
          repository: TykTechnologies/exp
          ref: main
          path: exp

      - name: Setup Go
        uses: actions/setup-go@v4
        with:
          go-version: ${{ inputs.go-version }}

      - name: Install Task
        uses: arduino/setup-task@v1
        with:
          version: 3

      - name: Set up comment author
        run: |
          git config --local user.email "github-actions[bot]@users.noreply.github.com"
          git config --local user.name "github-actions[bot]"

      - name: Collect API docs
        run: |
          cp ./exp/.taskfiles/godoc/Taskfile.yml ./Taskfile.godoc.yml

          go mod tidy
          task -t Taskfile.godoc.yml > current.txt

          git checkout -- .
          git fetch --depth=1 origin ${{ github.base_ref }}
          git checkout ${{ github.base_ref }}

          go mod tidy
          task -t Taskfile.godoc.yml > prev.txt

      - name: Diff API docs
        id: api-check
        run: |
          set +e
          diff -u prev.txt current.txt > changes.txt
          echo "diff-output<<EOF" >> $GITHUB_OUTPUT
          cat changes.txt >> $GITHUB_OUTPUT
          echo "EOF" >> $GITHUB_OUTPUT

      - name: Find Comment
        uses: peter-evans/find-comment@v2
        id: fc
        with:
          issue-number: ${{ github.event.pull_request.number }}
          comment-author: 'github-actions[bot]'
          body-includes: API Changes

      - name: Create or update comment
        uses: peter-evans/create-or-update-comment@v3
        with:
          comment-id: ${{ steps.fc.outputs.comment-id }}
          issue-number: ${{ github.event.pull_request.number }}
          body: |
            API Changes
            ```diff
            ${{ steps.api-check.outputs.diff-output || 'no api changes detected' }}
            ```
          edit-mode: replace