ltetzlaff / swift-api-diff

🔀🆕 Comment changes in public interfaces on GitHub Pull Requests

swift-api-diff

This generates per-PR diff reports in the public API of a swift module. It's based on the Swift-NIO team's api breakage script

Usage example

name: SwiftAPIBreakage

on:
  pull_request:
    types: [opened, synchronize]

jobs:
  buildAndCheckAPIBreakage:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          ref: master
          fetch-depth: 0
      - uses: ltetzlaff/swift-api-diff@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Example with a change

ltetzlaff/swift-api-diff-example#4

Example without a change

ltetzlaff/swift-api-diff-example#3