Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Breaking changes flow #677

Merged
merged 1 commit into from
Apr 15, 2022
Merged

Breaking changes flow #677

merged 1 commit into from
Apr 15, 2022

Conversation

S2Ler
Copy link
Contributor

@S2Ler S2Ler commented Apr 7, 2022

  • Uses swift package diagnose-api-breaking-changes to detect breaking changes.
  • I wasn't able to setup mbx-ci/gh tools to post pr comments, so if job fails, you will have to go to circleci and check what's wrong. The list of breaking changes will be available in artificats.

@S2Ler S2Ler force-pushed the s2ler/breaking-changes-detection branch 8 times, most recently from 8fad48e to 4e6bb50 Compare April 7, 2022 21:49
@S2Ler S2Ler requested a review from a team April 7, 2022 21:57
@S2Ler S2Ler self-assigned this Apr 7, 2022
@S2Ler S2Ler added the op-ex Refactoring, Tech Debt or any other operational excellence work. label Apr 7, 2022
@S2Ler S2Ler added this to the v2.4 milestone Apr 7, 2022
@S2Ler S2Ler marked this pull request as ready for review April 7, 2022 21:57
swift-package-baseline/baseline.txt Outdated Show resolved Hide resolved
.circleci/config.yml Outdated Show resolved Hide resolved
.circleci/config.yml Outdated Show resolved Hide resolved
.circleci/config.yml Outdated Show resolved Hide resolved
@bamx23
Copy link
Contributor

bamx23 commented Apr 8, 2022

We should also add a new step to releasing instructions:

After releasing a final or RC version, update swift-package-baseline/baseline.txt, run swift package diagnose-api-breaking-changes --products MapboxDirections --baseline-dir swift-package-baseline --breakage-allowlist-path swift-package-baseline/breakage-allowlist-path.txt $(cat swift-package-baseline/baseline.txt) and remove previous baseline directory(the one with commit hash).

We can also automate this as part of the release process on CI by creating a pipeline that runs this on tag push and creates a PR.

@S2Ler S2Ler force-pushed the s2ler/breaking-changes-detection branch 4 times, most recently from 5b5c53f to 56229e2 Compare April 11, 2022 08:46
.circleci/config.yml Outdated Show resolved Hide resolved
scripts/breaking-changes/parse-breaking-changes-output.py Outdated Show resolved Hide resolved
.circleci/config.yml Outdated Show resolved Hide resolved
@S2Ler S2Ler force-pushed the s2ler/breaking-changes-detection branch 4 times, most recently from 0fff810 to 3e87ad9 Compare April 11, 2022 13:38
@S2Ler S2Ler requested review from a team and bamx23 April 11, 2022 13:46
@S2Ler
Copy link
Contributor Author

S2Ler commented Apr 11, 2022

We can also automate this as part of the release process on CI by creating a pipeline that runs this on tag push and creates a PR.

As I mentioned in the previous step it is not designed to be updated frequently. The script is added though. CI integration isn't important enough given that you don't need to run it frequently. But can be done in a separate PR if needed.

@S2Ler S2Ler force-pushed the s2ler/breaking-changes-detection branch 3 times, most recently from 4022161 to cb01af2 Compare April 13, 2022 17:21
@S2Ler S2Ler requested a review from 1ec5 April 13, 2022 17:23
Copy link
Contributor

@bamx23 bamx23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just several suggestions.
And it's only 2-3 minutes to run this new CI job without a cached/vendored baseline, nice!

scripts/update-baseline.sh Outdated Show resolved Hide resolved
scripts/update-version.sh Outdated Show resolved Hide resolved
swift-package-baseline/README.md Show resolved Hide resolved
@S2Ler S2Ler force-pushed the s2ler/breaking-changes-detection branch 2 times, most recently from 0a99680 to 414187e Compare April 15, 2022 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
op-ex Refactoring, Tech Debt or any other operational excellence work.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants