detect_api_changes.yml

name: 👀 Detect public API changes

on:
  pull_request:
    types: [opened, synchronize, reopened]
  workflow_dispatch:
    inputs:
      new:
        description: 'Branch/tag of the new/updated version'
        required: true
      old:
        description: 'Branch/tag of the old/comparison version'
        required: true
      
jobs:

  build:
    runs-on: macos-14 # Apple Silicon Runner

    steps:
    - uses: actions/checkout@v4
    - uses: n1hility/cancel-previous-runs@v3
      with:
        token: ${{ secrets.GITHUB_TOKEN }}

    - name: Select latest Xcode
      uses: maxim-lobanov/setup-xcode@v1
      with:
        xcode-version: '15.4'
        
    - name: 🚚 Fetch repo
      uses: actions/checkout@v4
      with:
        fetch-depth: 0
        
    - name: 🔍 Detect Changes
      run: |
        PROJECT_FOLDER=$PWD
        
        NEW="${{ env.source }}~${{ env.githubRepo }}"
        if [[ '${{ github.head_ref || env.noTargetBranch }}' == 'release/*' ]]
        then
            LATEST_TAG=$(git describe --tags --abbrev=0)
            OLD="$LATEST_TAG~${{ env.githubRepo }}"
        else
            OLD="${{ env.target }}~${{ env.githubRepo }}"
        fi
        
        cd Scripts
        ./public-api-diff project --new "$NEW" --old "$OLD" --output "$PROJECT_FOLDER/api_comparison.md" --log-output "$PROJECT_FOLDER/logs.txt"
        cat "$PROJECT_FOLDER/logs.txt"
        cat "$PROJECT_FOLDER/api_comparison.md" >> $GITHUB_STEP_SUMMARY
      env:
        source: '${{ github.event.inputs.new || github.head_ref }}'
        target: '${{ github.event.inputs.old || github.event.pull_request.base.ref }}'
        githubRepo: '${{github.server_url}}/${{github.repository}}.git'
        noTargetBranch: 'no target branch'
       
    - if: ${{ github.event.pull_request.base.ref != '' }}
      name: 📝 Comment on PR
      uses: thollander/actions-comment-pull-request@v3
      with:
        file-path: "${{ github.workspace }}/api_comparison.md"
        comment-tag: api_changes
        mode: recreate