Skip to content

πŸ”€πŸ†• Comment changes in public interfaces on GitHub Pull Requests

License

Notifications You must be signed in to change notification settings

ltetzlaff/swift-api-diff

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

47965ff Β· Jan 12, 2020

History

14 Commits
Jan 12, 2020
Jan 12, 2020
Jan 2, 2020
Jan 2, 2020
Jan 3, 2020
Jan 12, 2020
Jan 12, 2020
Jan 12, 2020
Jan 12, 2020
Jan 12, 2020
Jan 12, 2020
Jan 12, 2020
Jan 12, 2020
Jan 12, 2020

Repository files navigation

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

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

About

πŸ”€πŸ†• Comment changes in public interfaces on GitHub Pull Requests

Resources

License

Stars

Watchers

Forks

Packages

No packages published