Skip to content

Commit

Permalink
Update changelog for 0.3.0 release (apple#229)
Browse files Browse the repository at this point in the history
  • Loading branch information
natecook1000 authored Aug 15, 2020
1 parent 8dfa177 commit 15351c1
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 6 deletions.
32 changes: 30 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,40 @@ This project follows semantic versioning. While still in major version `0`,
source-stability is only guaranteed within minor versions (e.g. between
`0.0.3` and `0.0.4`). If you want to guard against potentially source-breaking
package updates, you can specify your package dependency using
`.upToNextMinor(from: "0.2.0")` as the requirement.
`.upToNextMinor(from: "0.3.0")` as the requirement.

## [Unreleased]

*No changes yet.*

---

## [0.3.0] - 2020-08-15

### Additions

- Shell completions scripts are now available for Fish.

### Changes

- Array properties without a default value are now treated as required for the
user of a command-line tool. In previous versions of the library, these
properties defaulted to an empty array; a deprecation was introduced for this
behavior in version 0.2.0.

*Migration:* Specify an empty array as the default value for properties that
should not require user input:

```swift
// old
@Option var names: [String]
// new
@Option var names: [String] = []
```

The 0.3.0 release includes contributions from [dduan], [MPLew-is],
[natecook1000], and [thomasvl]. Thank you!

## [0.2.2] - 2020-08-05

### Fixes
Expand Down Expand Up @@ -303,7 +329,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/0.2.2...HEAD
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/0.3.0...HEAD
[0.3.0]: https://github.com/apple/swift-argument-parser/compare/0.2.2...0.3.0
[0.2.2]: https://github.com/apple/swift-argument-parser/compare/0.2.1...0.2.2
[0.2.1]: https://github.com/apple/swift-argument-parser/compare/0.2.0...0.2.1
[0.2.0]: https://github.com/apple/swift-argument-parser/compare/0.1.0...0.2.0
Expand Down Expand Up @@ -353,6 +380,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
[sharplet]: https://github.com/apple/swift-argument-parser/commits?author=sharplet
[sjavora]: https://github.com/apple/swift-argument-parser/commits?author=sjavora
[stuartcarnie]: https://github.com/apple/swift-argument-parser/commits?author=stuartcarnie
[thomasvl]: https://github.com/apple/swift-argument-parser/commits?author=thomasvl
[toddthomas]: https://github.com/apple/swift-argument-parser/commits?author=toddthomas
[Wevah]: https://github.com/apple/swift-argument-parser/commits?author=Wevah
[Wildchild9]: https://github.com/apple/swift-argument-parser/commits?author=Wildchild9
Expand Down
2 changes: 1 addition & 1 deletion Documentation/01 Getting Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import PackageDescription
let package = Package(
name: "random",
dependencies: [
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "0.2.0"),
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "0.3.0"),
],
targets: [
.target(
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ To use the `ArgumentParser` library in a SwiftPM project,
add the following line to the dependencies in your `Package.swift` file:

```swift
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.2.0"),
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.3.0"),
```

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

```swift
.package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "0.2.0")),
.package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "0.3.0")),
```

Finally, include `"ArgumentParser"` as a dependency for your executable target:
Expand All @@ -106,7 +106,7 @@ Finally, include `"ArgumentParser"` as a dependency for your executable target:
let package = Package(
// name, platforms, products, etc.
dependencies: [
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.2.0"),
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.3.0"),
// other dependencies
],
targets: [
Expand Down

0 comments on commit 15351c1

Please sign in to comment.