mapbox / mapbox/mapbox-navigation-ios

Migrate breaking changes detector to swift-api-digester

Open
#3,830 2 comments 0 reactions 1 assignee View on GitHub

@S2Ler is already working on this.

Since Apr 15, 2022.

jira-sync-complete op-ex
Dominant language
Swift
Stars
918
Forks
326
Avg merge
1h 16m
Merged PRs (30d)
3

Description

# Now

We detect breaking changes by building an abstract syntax tree from the source code using "SourceKit" and then building the diff and then analysing what is considered a breaking change.

# Proposed

Use `swift-api-digester` tool that ships with Xcode to detect breaking API changes.

# Why

Instead of maintaining the own tool, we will use a tool that is maintained by compiler engineers that will have less false positives that we currently have.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.