apple / swift-openapi-generator

Generate Swift client and server code from an OpenAPI document.
https://swiftpackageindex.com/apple/swift-openapi-generator/documentation
Apache License 2.0
1.45k stars 121 forks source link

[CI] Disable the API breakage check #647

Closed czechboy0 closed 1 month ago

czechboy0 commented 1 month ago

Motivation

This package doesn't have any library products that would need to maintain API stability, so we don't need to run the CI.

We only have _OpenAPIGeneratorCore, which is underscored and not expected to be API stable (so it can only be used using an exact: "..." constraint). But we don't want to fail CI when we change that API (right now it's introducing noise in: https://github.com/apple/swift-openapi-generator/pull/627)

Modifications

Disable API breakage check.

Result

Disabled that CI step.

Test Plan

N/A

simonjbeaumont commented 1 month ago

Should we instead keep it but relax the rule. Be good to know when we're breaking the underscored library product?

czechboy0 commented 1 month ago

We don't even attempt to keep the underscored library's API stable, it's purely for experimentation with in-memory codegen. So I don't particularly care when we break its API.