Deprecate API by version of my package

nashysolutions · September 17, 2021, 5:01am

I want to use the available attributes in my package to specify when some API becomes available, or for when some API becomes deprecated.

https://docs.swift.org/swift-book/ReferenceManual/Attributes.html

At the moment, it seems I can only specify the release of the operating system (not the release of my package). Is this correct?

So for instance I have a package named JellyBeans and the following suggests that the API was deprecated in the release of iOS 2.0.1, (as opposed to the release of JellyBeans 2.0.1).

@available(iOS, deprecated: 2.0.1)

0xTim · September 17, 2021, 8:01am

Correct, though you can specify any release

@available(*, deprecated, message: "This API was deprecated in 2.0.1")

So it shows up in clients

toph42 · September 18, 2021, 12:29pm

Seems worthy of a Pitch to extend @available to specify @available(PackageName, …) (at least to hear from experts in the discussion if there’s some technological barriers to this approach).

alexandrehsaad · October 26, 2022, 4:13pm

@toph42 has this been proposed?

hassila · October 26, 2022, 4:25pm

Might point out:

github.com/apple/swift

Availability annotations for third party libraries when using Library evolution/ resilience

opened 10:27AM - 09 Aug 22 UTC

hassila

New Feature

**Is your feature request related to a problem? Please describe.** We’ve ende…d up realizing we’d like to use the library evolution features for resilient api surfaces for our product (yes, needed for an enterprise solution where clients of libraries must be able to be replaced independently and don’t have source access. Both macOS and Linux. Aware of tool chain impedance matching on Linux required - that’s ok). The question is how we can evolve our api with availability annotations? Current annotations for availability is tied to platform or swift version only, but we'd want to tie it to our products version numbers instead. Not sure the best way to express it, but if a typical swift macro would be: `@available(swift 5.1)` we'd want something like: `@available(ourProductName 2.0)` which we could use with e.g. ``` if #available (ourProductName 2.0) { return x } else { return y } ``` or e.g. `@available(ourProductName , deprecated: 3, renamed: "newNameForThis")` **Describe the solution you'd like** Add support for third-party availability annotations to allow tying availability to our product releases instead of platform/swift versions. **Describe alternatives you've considered** As a stop-gap we considered to tie it to Swift releases instead, which is not really a good workaround, but AFAWU it's fundamentally the only option we have (for it to work on both Linux and macOS) - and not very good conceptually. **Additional context** Some background discussion here: https://forums.swift.org/t/availability-when-using-library-evolution-resilience-for-third-party-libraries/59341