Skip to content

Commit

Permalink
Update changelog with latest changes (apple#600)
Browse files Browse the repository at this point in the history
  • Loading branch information
natecook1000 authored Dec 6, 2023
1 parent 66e0d7d commit c8ed701
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 7 deletions.
51 changes: 47 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,46 @@ Add new items at the end of the relevant section under **Unreleased**.

## [Unreleased]

*No new changes.*

---

## [1.3.0] - 2023-12-06

### Changes

- The `@Option`, `@Argument`, `@Flag`, and `@OptionGroup` property wrappers now
conditionally conform to `Sendable` when the wrapper's `Value` type conforms. With this
change, you can mark `ParsableCommand` types as `Sendable` when you want to be able to
pass a parsed command across concurrent contexts. ([#582])

*Migration:* Users that aren't ready to resolve sendability warnings can add the
`@preconcurrency` attribute to `import ArgumentParser` statements.

- To support migration to `Sendable` annotation, the minimum Swift version for
`swift-argument-parser` has been increased to Swift 5.7. Users of older Swift versions
will be able to continue using version 1.2.3 of the library. ([#582])

### Additions

- Help screens now include possible options for `ExpressibleByArgument` types
with non empty `allValueStrings`. Types also conforming to `CaseIterable` do
not need to manually implement `allValueStrings`, instead it is derived from
`allCases`. ([#594])

<!-- Add: "Don't remove nested option group titles (#592)" -->
<!-- Add: "Document ability to skip unknown parameters (#572)" -->
### Fixes

- The titles for nested option groups are preserved when embedded into commands without
specifying a new title. ([#592])
- When wrapping help and error messages, the library now uses the `COLUMNS` environment
variable when set, instead of immediately falling back to 80 columns. ([#596])
- Bash completion scripts now respect the extensions given in a `.file(...)` completion
kind. ([#590])
- Bash completion scripts now properly escape command names that include hyphens. ([#573])
- Documentation improvements. ([#572], [#565], [#602])

The 1.2.3 release includes contributions from [Alkenso], [compnerd], [gwynne],
[kennyyork], [natecook1000], [rauhul], [robertmryan], and [vlm]. Thank you!

---

Expand Down Expand Up @@ -803,7 +834,8 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co

<!-- Link references for releases -->

[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.2.3...HEAD
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.3.0...HEAD
[1.3.0]: https://github.com/apple/swift-argument-parser/compare/1.2.3...1.3.0
[1.2.3]: https://github.com/apple/swift-argument-parser/compare/1.2.2...1.2.3
[1.2.2]: https://github.com/apple/swift-argument-parser/compare/1.2.1...1.2.2
[1.2.1]: https://github.com/apple/swift-argument-parser/compare/1.2.0...1.2.1
Expand Down Expand Up @@ -897,16 +929,25 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
[#550]: https://github.com/apple/swift-argument-parser/pull/550
[#552]: https://github.com/apple/swift-argument-parser/pull/552
[#554]: https://github.com/apple/swift-argument-parser/pull/554
[#565]: https://github.com/apple/swift-argument-parser/pull/565
[#572]: https://github.com/apple/swift-argument-parser/pull/572
[#573]: https://github.com/apple/swift-argument-parser/pull/573
[#574]: https://github.com/apple/swift-argument-parser/pull/574
[#579]: https://github.com/apple/swift-argument-parser/pull/579
[#579]: https://github.com/apple/swift-argument-parser/pull/594
[#582]: https://github.com/apple/swift-argument-parser/pull/582
[#590]: https://github.com/apple/swift-argument-parser/pull/590
[#592]: https://github.com/apple/swift-argument-parser/pull/592
[#594]: https://github.com/apple/swift-argument-parser/pull/594
[#596]: https://github.com/apple/swift-argument-parser/pull/596
[#602]: https://github.com/apple/swift-argument-parser/pull/602

<!-- Link references for contributors -->

[3405691582]: https://github.com/apple/swift-argument-parser/commits?author=3405691582
[adellibovi]: https://github.com/apple/swift-argument-parser/commits?author=adellibovi
[aleksey-mashanov]: https://github.com/apple/swift-argument-parser/commits?author=aleksey-mashanov
[AliSoftware]: https://github.com/apple/swift-argument-parser/commits?author=AliSoftware
[Alkenso]: https://github.com/apple/swift-argument-parser/commits?author=Alkenso
[allevato]: https://github.com/apple/swift-argument-parser/commits?author=allevato
[artemnovichkov]: https://github.com/apple/swift-argument-parser/commits?author=artemnovichkov
[atierian]: https://github.com/apple/swift-argument-parser/commits?author=atierian
Expand Down Expand Up @@ -968,6 +1009,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
[rauhul]: https://github.com/apple/swift-argument-parser/commits?author=rauhul
[rickrizzo]: https://github.com/apple/swift-argument-parser/commits?author=rickrizzo
[rjstelling]: https://github.com/apple/swift-argument-parser/commits?author=rjstelling
[robertmryan]: https://github.com/apple/swift-argument-parser/commits?author=robertmryan
[Sajjon]: https://github.com/apple/swift-argument-parser/commits?author=Sajjon
[schlagelk]: https://github.com/apple/swift-argument-parser/commits?author=schlagelk
[SergeyPetrachkov]: https://github.com/apple/swift-argument-parser/commits?author=SergeyPetrachkov
Expand All @@ -978,6 +1020,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
[thomasvl]: https://github.com/apple/swift-argument-parser/commits?author=thomasvl
[TiagoMaiaL]: https://github.com/apple/swift-argument-parser/commits?author=TiagoMaiaL
[toddthomas]: https://github.com/apple/swift-argument-parser/commits?author=toddthomas
[vlm]: https://github.com/apple/swift-argument-parser/commits?author=vlm
[werm098]: https://github.com/apple/swift-argument-parser/commits?author=werm098
[Wevah]: https://github.com/apple/swift-argument-parser/commits?author=Wevah
[Wildchild9]: https://github.com/apple/swift-argument-parser/commits?author=Wildchild9
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ let package = Package(
// name, platforms, products, etc.
dependencies: [
// other dependencies
.package(url: "https://github.com/apple/swift-argument-parser", from: "1.2.0"),
.package(url: "https://github.com/apple/swift-argument-parser", from: "1.3.0"),
],
targets: [
.executableTarget(name: "<command-line-tool>", dependencies: [
Expand All @@ -144,4 +144,4 @@ swift-argument-parser | Minimum Swift Version
`0.0.1 ..< 0.2.0` | 5.1
`0.2.0 ..< 1.1.0` | 5.2
`1.1.0 ..< 1.3.0` | 5.5
`1.3.0 ...` (future) | 5.7
`1.3.0 ...` | 5.7
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import PackageDescription
let package = Package(
name: "Count",
dependencies: [
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.2.0"),
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.3.0"),
],
targets: [
.executableTarget(
Expand Down

0 comments on commit c8ed701

Please sign in to comment.