Skip to content

Commit c8ed701

Browse files
authored
Update changelog with latest changes (#600)
1 parent 66e0d7d commit c8ed701

File tree

3 files changed

+50
-7
lines changed

3 files changed

+50
-7
lines changed

CHANGELOG.md

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,46 @@ Add new items at the end of the relevant section under **Unreleased**.
66

77
## [Unreleased]
88

9+
*No new changes.*
10+
11+
---
12+
13+
## [1.3.0] - 2023-12-06
14+
15+
### Changes
16+
17+
- The `@Option`, `@Argument`, `@Flag`, and `@OptionGroup` property wrappers now
18+
conditionally conform to `Sendable` when the wrapper's `Value` type conforms. With this
19+
change, you can mark `ParsableCommand` types as `Sendable` when you want to be able to
20+
pass a parsed command across concurrent contexts. ([#582])
21+
22+
*Migration:* Users that aren't ready to resolve sendability warnings can add the
23+
`@preconcurrency` attribute to `import ArgumentParser` statements.
24+
25+
- To support migration to `Sendable` annotation, the minimum Swift version for
26+
`swift-argument-parser` has been increased to Swift 5.7. Users of older Swift versions
27+
will be able to continue using version 1.2.3 of the library. ([#582])
28+
929
### Additions
1030

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

16-
<!-- Add: "Don't remove nested option group titles (#592)" -->
17-
<!-- Add: "Document ability to skip unknown parameters (#572)" -->
36+
### Fixes
37+
38+
- The titles for nested option groups are preserved when embedded into commands without
39+
specifying a new title. ([#592])
40+
- When wrapping help and error messages, the library now uses the `COLUMNS` environment
41+
variable when set, instead of immediately falling back to 80 columns. ([#596])
42+
- Bash completion scripts now respect the extensions given in a `.file(...)` completion
43+
kind. ([#590])
44+
- Bash completion scripts now properly escape command names that include hyphens. ([#573])
45+
- Documentation improvements. ([#572], [#565], [#602])
46+
47+
The 1.2.3 release includes contributions from [Alkenso], [compnerd], [gwynne],
48+
[kennyyork], [natecook1000], [rauhul], [robertmryan], and [vlm]. Thank you!
1849

1950
---
2051

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

804835
<!-- Link references for releases -->
805836

806-
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.2.3...HEAD
837+
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.3.0...HEAD
838+
[1.3.0]: https://github.com/apple/swift-argument-parser/compare/1.2.3...1.3.0
807839
[1.2.3]: https://github.com/apple/swift-argument-parser/compare/1.2.2...1.2.3
808840
[1.2.2]: https://github.com/apple/swift-argument-parser/compare/1.2.1...1.2.2
809841
[1.2.1]: https://github.com/apple/swift-argument-parser/compare/1.2.0...1.2.1
@@ -897,16 +929,25 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
897929
[#550]: https://github.com/apple/swift-argument-parser/pull/550
898930
[#552]: https://github.com/apple/swift-argument-parser/pull/552
899931
[#554]: https://github.com/apple/swift-argument-parser/pull/554
932+
[#565]: https://github.com/apple/swift-argument-parser/pull/565
933+
[#572]: https://github.com/apple/swift-argument-parser/pull/572
934+
[#573]: https://github.com/apple/swift-argument-parser/pull/573
900935
[#574]: https://github.com/apple/swift-argument-parser/pull/574
901936
[#579]: https://github.com/apple/swift-argument-parser/pull/579
902-
[#579]: https://github.com/apple/swift-argument-parser/pull/594
937+
[#582]: https://github.com/apple/swift-argument-parser/pull/582
938+
[#590]: https://github.com/apple/swift-argument-parser/pull/590
939+
[#592]: https://github.com/apple/swift-argument-parser/pull/592
940+
[#594]: https://github.com/apple/swift-argument-parser/pull/594
941+
[#596]: https://github.com/apple/swift-argument-parser/pull/596
942+
[#602]: https://github.com/apple/swift-argument-parser/pull/602
903943

904944
<!-- Link references for contributors -->
905945

906946
[3405691582]: https://github.com/apple/swift-argument-parser/commits?author=3405691582
907947
[adellibovi]: https://github.com/apple/swift-argument-parser/commits?author=adellibovi
908948
[aleksey-mashanov]: https://github.com/apple/swift-argument-parser/commits?author=aleksey-mashanov
909949
[AliSoftware]: https://github.com/apple/swift-argument-parser/commits?author=AliSoftware
950+
[Alkenso]: https://github.com/apple/swift-argument-parser/commits?author=Alkenso
910951
[allevato]: https://github.com/apple/swift-argument-parser/commits?author=allevato
911952
[artemnovichkov]: https://github.com/apple/swift-argument-parser/commits?author=artemnovichkov
912953
[atierian]: https://github.com/apple/swift-argument-parser/commits?author=atierian
@@ -968,6 +1009,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
9681009
[rauhul]: https://github.com/apple/swift-argument-parser/commits?author=rauhul
9691010
[rickrizzo]: https://github.com/apple/swift-argument-parser/commits?author=rickrizzo
9701011
[rjstelling]: https://github.com/apple/swift-argument-parser/commits?author=rjstelling
1012+
[robertmryan]: https://github.com/apple/swift-argument-parser/commits?author=robertmryan
9711013
[Sajjon]: https://github.com/apple/swift-argument-parser/commits?author=Sajjon
9721014
[schlagelk]: https://github.com/apple/swift-argument-parser/commits?author=schlagelk
9731015
[SergeyPetrachkov]: https://github.com/apple/swift-argument-parser/commits?author=SergeyPetrachkov
@@ -978,6 +1020,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
9781020
[thomasvl]: https://github.com/apple/swift-argument-parser/commits?author=thomasvl
9791021
[TiagoMaiaL]: https://github.com/apple/swift-argument-parser/commits?author=TiagoMaiaL
9801022
[toddthomas]: https://github.com/apple/swift-argument-parser/commits?author=toddthomas
1023+
[vlm]: https://github.com/apple/swift-argument-parser/commits?author=vlm
9811024
[werm098]: https://github.com/apple/swift-argument-parser/commits?author=werm098
9821025
[Wevah]: https://github.com/apple/swift-argument-parser/commits?author=Wevah
9831026
[Wildchild9]: https://github.com/apple/swift-argument-parser/commits?author=Wildchild9

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ let package = Package(
123123
// name, platforms, products, etc.
124124
dependencies: [
125125
// other dependencies
126-
.package(url: "https://github.com/apple/swift-argument-parser", from: "1.2.0"),
126+
.package(url: "https://github.com/apple/swift-argument-parser", from: "1.3.0"),
127127
],
128128
targets: [
129129
.executableTarget(name: "<command-line-tool>", dependencies: [
@@ -144,4 +144,4 @@ swift-argument-parser | Minimum Swift Version
144144
`0.0.1 ..< 0.2.0` | 5.1
145145
`0.2.0 ..< 1.1.0` | 5.2
146146
`1.1.0 ..< 1.3.0` | 5.5
147-
`1.3.0 ...` (future) | 5.7
147+
`1.3.0 ...` | 5.7

Sources/ArgumentParser/Documentation.docc/Articles/GettingStarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import PackageDescription
2121
let package = Package(
2222
name: "Count",
2323
dependencies: [
24-
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.2.0"),
24+
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.3.0"),
2525
],
2626
targets: [
2727
.executableTarget(

0 commit comments

Comments
 (0)