Skip to content
Merged
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
53 changes: 50 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,51 @@ Add new items at the end of the relevant section under **Unreleased**.

---

## [1.1.4] - 2022-08-26

### Changes

- The generate-manual plugin now defaults to creating single page manuals. The
`--single-page` flag has been replaced with `--multi-page` to restore the
previous default functionality. ([#472])

*Migration:* Update scripts that invoked generate-manual without
`--single-page` to include `--multi-page` and update scripts that invoked
generate-manual with `--single-page` to omit the flag.

- The "experimental" prefix from the generate-manual plugin has been removed.
([#475])

*Migration:* Update scripts to invoke the generate manual plugin via
`swift package generate-manual` instead of
`swift package plugin experimental-generate-manual`.

### Fixes

- The generate-manual plugin is correctly declared as a product, making the
plugin visible to clients. ([#456])
- The generate-manual plugin's `--authors` arguments are now correctly passed to
the underlying generation tool. ([#471])
- Manuals generated by the generate-manual plugin now include the option's value
names and do not include value names for flags. ([#473])
- Built-in flags such as `--help` and `--version` are now correctly marked as
optional fixing some generated content which indicated the flags are always
required. ([#474])
- Value descriptions are now correctly derived for types which are
`ExpressibleByArgument` and `RawRepresentable` by `String`. Help menus will
now display valid default values for such types. ([#476])

The 1.1.4 release includes contributions from [ian-twilightcoder],
[MarcoEidinger], and [rauhul]. Thank you!

## [1.1.3] - 2022-06-23

### Additions

- `ArgumentParser` now includes a SwiftPM plugin for generating `man` pages.
Explore the functionality and configuration by running
`swift package plugin experimental-generate-manual --help` from your package root.
([#332])
`swift package plugin experimental-generate-manual --help` from your package
root. ([#332])

### Fixes

Expand Down Expand Up @@ -654,7 +691,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.1.3...HEAD
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.1.4...HEAD
[1.1.4]: https://github.com/apple/swift-argument-parser/compare/1.1.3...1.1.4
[1.1.3]: https://github.com/apple/swift-argument-parser/compare/1.1.2...1.1.3
[1.1.2]: https://github.com/apple/swift-argument-parser/compare/1.1.1...1.1.2
[1.1.1]: https://github.com/apple/swift-argument-parser/compare/1.1.0...1.1.1
Expand Down Expand Up @@ -718,6 +756,13 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
[#436]: https://github.com/apple/swift-argument-parser/pull/436
[#443]: https://github.com/apple/swift-argument-parser/pull/443
[#445]: https://github.com/apple/swift-argument-parser/pull/445
[#456]: https://github.com/apple/swift-argument-parser/pull/456
[#471]: https://github.com/apple/swift-argument-parser/pull/471
[#472]: https://github.com/apple/swift-argument-parser/pull/472
[#473]: https://github.com/apple/swift-argument-parser/pull/473
[#474]: https://github.com/apple/swift-argument-parser/pull/474
[#475]: https://github.com/apple/swift-argument-parser/pull/475
[#476]: https://github.com/apple/swift-argument-parser/pull/476

<!-- Link references for contributors -->

Expand Down Expand Up @@ -745,6 +790,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
[gmittert]: https://github.com/apple/swift-argument-parser/commits?author=gmittert
[griffin-stewie]: https://github.com/apple/swift-argument-parser/commits?author=griffin-stewie
[iainsmith]: https://github.com/apple/swift-argument-parser/commits?author=iainsmith
[ian-twilightcoder]: https://github.com/apple/swift-argument-parser/commits?author=ian-twilightcoder
[ibrahimoktay]: https://github.com/apple/swift-argument-parser/commits?author=ibrahimoktay
[imxieyi]: https://github.com/apple/swift-argument-parser/commits?author=imxieyi
[IngmarStein]: https://github.com/apple/swift-argument-parser/commits?author=IngmarStein
Expand All @@ -762,6 +808,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
[Lantua]: https://github.com/apple/swift-argument-parser/commits?author=Lantua
[lorentey]: https://github.com/apple/swift-argument-parser/commits?author=lorentey
[LucianoPAlmeida]: https://github.com/apple/swift-argument-parser/commits?author=LucianoPAlmeida
[MarcoEidinger]: https://github.com/apple/swift-argument-parser/commits?author=MarcoEidinger
[MartinP7r]: https://github.com/apple/swift-argument-parser/commits?author=MartinP7r
[MaxDesiatov]: https://github.com/apple/swift-argument-parser/commits?author=MaxDesiatov
[McNight]: https://github.com/apple/swift-argument-parser/commits?author=McNight
Expand Down