swift-openapi-generator icon indicating copy to clipboard operation
swift-openapi-generator copied to clipboard

Published 20 hours ago • verified publisher icon apple

Add a CI pipeline for catching API-breaking changes

Open czechboy0 opened this issue 2 years ago • 5 comments

czechboy0 avatar Jun 08 '23 18:06 czechboy0

We have a tight dependency on the packages in the Swift OpenAPI project, which are part of different repositories. Most notably we have the interplay between swift-openapi-generator and swift-openapi-runtime. The latter vends SPI that's used in the generated code.

We'd like to be able to use the integration test package in this repo to test changes made in this repo and the runtime repo.

Additionally we may wish to consider using swift package diagnose-api-breaking-changes in the pipeline of the runtime library.

simonjbeaumont avatar Jun 08 '23 22:06 simonjbeaumont

We'd like to be able to use the integration test package in this repo to test changes made in this repo and the runtime repo.

Here's the PR for the generator: https://github.com/apple/swift-openapi-generator/pull/56

simonjbeaumont avatar Jun 08 '23 22:06 simonjbeaumont

Here's the PR for the runtime: https://github.com/apple/swift-openapi-runtime/pull/17

simonjbeaumont avatar Jun 09 '23 10:06 simonjbeaumont

@simonjbeaumont Ready to close this?

czechboy0 avatar Jun 14 '23 06:06 czechboy0

Since the integration test was added to CI, renaming to track adding the diagnosis of API-breaking changes to the runtime repo.

czechboy0 avatar Jun 20 '23 14:06 czechboy0

Since the integration test was added to CI, renaming to track adding the diagnosis of API-breaking changes to the runtime repo.

Done: https://github.com/apple/swift-openapi-runtime/pull/21.

I think we'll want to add an API breaking change to the generated code, but I think that's beyond the scope of this issue, so I'm closing this one now.

simonjbeaumont avatar Jun 28 '23 06:06 simonjbeaumont