Skip to content

Releases: apple/swift-configuration

1.0.0-alpha.1

27 Nov 09:46
af63e6e

Choose a tag to compare

This is the first alpha release of Swift Configuration 1.0.0. There are no more planned API-breaking changes and unless issues come up, this is the API shape that will be stabilized as Swift Configuration 1.0.0 in a couple of weeks.

Please update your libraries and applications to use this alpha release and provide feedback 🙏

⚠️ API-breaking changes between 0.2.0 and 1.0.0-alpha.1

  • Generic file providers (Implementation of SCO-0001) by @czechboy0 in #60
    • Migration: Rename references from JSONProvider to FileProvider<JSONSnapshot>, same for YAMLProvider and their reloading variants.
  • Rename ConfigSnapshotProtocol -> ConfigSnapshot by @czechboy0 in #67
    • Migration: Rename references from ConfigSnapshotProtocol to ConfigSnapshot
  • Remove custom key decoders by @czechboy0 in #71
    • Migration: Use the period-separated default key decoder.
  • Rename ConfigReader.withSnapshot(_:) to ConfigReader.snapshot() by @czechboy0 in #79
    • Migration: Rename references from withSnapshot to snapshot.
  • Remove the ConfigKeyEncoder API by @czechboy0 in #86
    • Migration: Use the built-in key encoders.

Other changes

SemVer Minor

  • NonisolatedNonsendingByDefault and other concurrency fixes by @czechboy0 in #63
  • Add an allowMissing parameter to file-based providers by @czechboy0 in #73
  • Allow non-copyable Return types in with-style methods by @czechboy0 in #81
  • Add missing availability annotations in public APIs by @czechboy0 in #85

SemVer Patch

Other Changes

Full Changelog: 0.2.0...1.0.0-alpha.1

0.2.0

21 Oct 09:41
9d5e407

Choose a tag to compare

What's Changed

⚠️ Breaking changes between 0.1.x and 0.2.0

  • Rename bytes-from-string decoders in #57
  • Rename ProviderCompatTest.run() -> ProviderCompatTest.runTest() in #56

SemVer Minor

  • Default to enabled observability in #54
  • Expose AbsoluteConfigKey prepending/appending by @finnvoor in #39

SemVer Patch

  • [Refactor] Remove ConcreteAsyncSequence in #38
  • Move from platform versions to symbol availability in #48

Other Changes

  • [README] Fix 'Custom key syntax' link in #3
  • [CI] Enable static SDK builds in #4
  • Fix up a secrets example in #5
  • [Docs] Remove obsolete example about catching ConfigError in #7
  • Update Package.swift by @carlynorama in #9
  • [Docs] Fix up docs around key mapping in #46
  • Add linkage test in #53
  • [CI] Test examples in #50
  • chore: restrict GitHub workflow permissions - future-proof by @incertum in #59
  • Update docs for the 0.2.0 release in #58

New Contributors

Full Changelog: 0.1.1...0.2.0

0.1.1

24 Sep 11:08
7e5bc11

Choose a tag to compare

What's Changed

Other Changes

  • SPI needs the docc-plugin installed to build the docs - this fixes that scenario by @heckj in #1
  • Use the general runner pool for PRs by @czechboy0 in #2

New Contributors

Full Changelog: 0.1.0...0.1.1

0.1.0

23 Sep 19:23

Choose a tag to compare

Initial release - Hello, Swift Configuration!