Skip to content

Commit eb51f94

Browse files
authored
Update changelog for 0.2.0 release (#194)
1 parent 8de98bd commit eb51f94

File tree

3 files changed

+53
-6
lines changed

3 files changed

+53
-6
lines changed

CHANGELOG.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,56 @@ This project follows semantic versioning. While still in major version `0`,
88
source-stability is only guaranteed within minor versions (e.g. between
99
`0.0.3` and `0.0.4`). If you want to guard against potentially source-breaking
1010
package updates, you can specify your package dependency using
11-
`.upToNextMinor(from: "0.1.0")` as the requirement.
11+
`.upToNextMinor(from: "0.2.0")` as the requirement.
1212

1313
## [Unreleased]
1414

1515
*No changes yet.*
1616

17+
## [0.2.0] - 2020-06-23
18+
19+
### Additions
20+
21+
- You can now specify default values for array properties of parsable types.
22+
The default values are overridden if the user provides at least one value
23+
as part of the command-line arguments.
24+
25+
### Changes
26+
27+
- This release of `swift-argument-parser` requires Swift 5.2.
28+
- Default values for all properties are now written using default initialization
29+
syntax, including some values that were previously implicit, such as empty
30+
arrays and `false` for Boolean flags.
31+
32+
*Migration:* Specify default values using typical Swift default value syntax
33+
to remove the deprecation warnings:
34+
35+
```swift
36+
// old
37+
@Flag() var verbose: Bool
38+
// new
39+
@Flag() var verbose = false
40+
```
41+
42+
**_Important:_** There is a semantic change for flags with inversions that do
43+
not have a default value. In previous releases, these flags had a default
44+
value of `false`; starting in 0.2.0, these flags will have no default, and
45+
will therefore be required by the user. Specify a default value of `false` to
46+
retain the old behavior.
47+
48+
### Fixes
49+
50+
- Options with multiple names now consistently show the first-declared name
51+
in usage and help screens.
52+
- Default subcommands are indicated in the help screen.
53+
- User errors with options are now shown before positional argument errors,
54+
eliminating some false negative reports.
55+
- CMake compatibility fixes.
56+
57+
The 0.2.0 release includes contributions from [artemnovichkov], [compnerd],
58+
[ibrahimoktay], [john-mueller], [MPLew-is], [natecook1000], and [owenv].
59+
Thank you!
60+
1761
## [0.1.0] - 2020-06-03
1862

1963
### Additions
@@ -220,7 +264,8 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
220264

221265
<!-- Link references for releases -->
222266

223-
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/0.1.0...HEAD
267+
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/0.2.0...HEAD
268+
[0.2.0]: https://github.com/apple/swift-argument-parser/compare/0.1.0...0.2.0
224269
[0.1.0]: https://github.com/apple/swift-argument-parser/compare/0.0.6...0.1.0
225270
[0.0.6]: https://github.com/apple/swift-argument-parser/compare/0.0.5...0.0.6
226271
[0.0.5]: https://github.com/apple/swift-argument-parser/compare/0.0.4...0.0.5
@@ -237,6 +282,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
237282

238283
[aleksey-mashanov]: https://github.com/apple/swift-argument-parser/commits?author=aleksey-mashanov
239284
[AliSoftware]: https://github.com/apple/swift-argument-parser/commits?author=AliSoftware
285+
[artemnovichkov]: https://github.com/apple/swift-argument-parser/commits?author=artemnovichkov
240286
[BradLarson]: https://github.com/apple/swift-argument-parser/commits?author=BradLarson
241287
[buttaface]: https://github.com/apple/swift-argument-parser/commits?author=buttaface
242288
[compnerd]: https://github.com/apple/swift-argument-parser/commits?author=compnerd
@@ -254,6 +300,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
254300
[klaaspieter]: https://github.com/apple/swift-argument-parser/commits?author=klaaspieter
255301
[Lantua]: https://github.com/apple/swift-argument-parser/commits?author=Lantua
256302
[miguelangel-dev]: https://github.com/apple/swift-argument-parser/commits?author=miguelangel-dev
303+
[MPLew-is]: https://github.com/apple/swift-argument-parser/commits?author=MPLew-is
257304
[natecook1000]: https://github.com/apple/swift-argument-parser/commits?author=natecook1000
258305
[owenv]: https://github.com/apple/swift-argument-parser/commits?author=owenv
259306
[rjstelling]: https://github.com/apple/swift-argument-parser/commits?author=rjstelling

Documentation/01 Getting Started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import PackageDescription
1919
let package = Package(
2020
name: "random",
2121
dependencies: [
22-
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "0.1.0"),
22+
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "0.2.0"),
2323
],
2424
targets: [
2525
.target(

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ To use the `ArgumentParser` library in a SwiftPM project,
8888
add the following line to the dependencies in your `Package.swift` file:
8989

9090
```swift
91-
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.1.0"),
91+
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.2.0"),
9292
```
9393

9494
Because `ArgumentParser` is under active development,
@@ -97,7 +97,7 @@ If you don't want potentially source-breaking package updates,
9797
use this dependency specification instead:
9898

9999
```swift
100-
.package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "0.1.0")),
100+
.package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "0.2.0")),
101101
```
102102

103103
Finally, include `"ArgumentParser"` as a dependency for your executable target:
@@ -106,7 +106,7 @@ Finally, include `"ArgumentParser"` as a dependency for your executable target:
106106
let package = Package(
107107
// name, platforms, products, etc.
108108
dependencies: [
109-
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.1.0"),
109+
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.2.0"),
110110
// other dependencies
111111
],
112112
targets: [

0 commit comments

Comments
 (0)