Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ 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.0.1")` as the requirement.
`.upToNextMinor(from: "0.1.0")` as the requirement.

## [Unreleased]

*No changes yet.*

## [0.1.0] - 2020-06-03

### Additions

- Error messages and help screens now include information about how to request
Expand Down Expand Up @@ -40,6 +44,16 @@ package updates, you can specify your package dependency using
- `ParsableCommand`'s `run()` method requirement is now a `mutating` method,
allowing mutations to a command's properties, such as sorting an array of
arguments, without additional copying.

*Migration:* No changes are required for commands that are executed through
the `main()` method. If you manually parse a command and then call its
`run()` method, you may need to change the command from a constant to a
variable.

### Removals

- The `@Flag` initializers that were deprecated in version 0.0.6 are now
marked as unavailable.

### Fixes

Expand All @@ -54,6 +68,9 @@ package updates, you can specify your package dependency using
argument array.
- CMake builds work correctly again.

The 0.1.0 release includes contributions from [aleksey-mashanov], [BradLarson],
[compnerd], [erica], [ibrahimoktay], and [natecook1000]. Thank you!

## [0.0.6] - 2020-05-14

### Additions
Expand Down Expand Up @@ -203,7 +220,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.0.6...HEAD
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/0.1.0...HEAD
[0.1.0]: https://github.com/apple/swift-argument-parser/compare/0.0.6...0.1.0
[0.0.6]: https://github.com/apple/swift-argument-parser/compare/0.0.5...0.0.6
[0.0.5]: https://github.com/apple/swift-argument-parser/compare/0.0.4...0.0.5
[0.0.4]: https://github.com/apple/swift-argument-parser/compare/0.0.3...0.0.4
Expand All @@ -217,14 +235,18 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co

<!-- Link references for contributors -->

[aleksey-mashanov]: https://github.com/apple/swift-argument-parser/commits?author=aleksey-mashanov
[AliSoftware]: https://github.com/apple/swift-argument-parser/commits?author=AliSoftware
[BradLarson]: https://github.com/apple/swift-argument-parser/commits?author=BradLarson
[buttaface]: https://github.com/apple/swift-argument-parser/commits?author=buttaface
[compnerd]: https://github.com/apple/swift-argument-parser/commits?author=compnerd
[dduan]: https://github.com/apple/swift-argument-parser/commits?author=dduan
[elliottwilliams]: https://github.com/apple/swift-argument-parser/commits?author=elliottwilliams
[erica]: https://github.com/apple/swift-argument-parser/commits?author=erica
[glessard]: https://github.com/apple/swift-argument-parser/commits?author=glessard
[griffin-stewie]: https://github.com/apple/swift-argument-parser/commits?author=griffin-stewie
[iainsmith]: https://github.com/apple/swift-argument-parser/commits?author=iainsmith
[ibrahimoktay]: https://github.com/apple/swift-argument-parser/commits?author=ibrahimoktay
[IngmarStein]: https://github.com/apple/swift-argument-parser/commits?author=IngmarStein
[john-mueller]: https://github.com/apple/swift-argument-parser/commits?author=john-mueller
[jonathanpenn]: https://github.com/apple/swift-argument-parser/commits?author=jonathanpenn
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.0.1"),
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "0.1.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.0.1"),
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.1.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.0.1")),
.package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "0.1.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.0.1"),
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.1.0"),
// other dependencies
],
targets: [
Expand Down