Skip to content

Commit 9f39744

Browse files
authored
Update changelog for 1.1.4 release (#478)
1 parent 67fa3c0 commit 9f39744

File tree

1 file changed

+50
-3
lines changed

1 file changed

+50
-3
lines changed

CHANGELOG.md

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,51 @@ Add new items at the end of the relevant section under **Unreleased**.
1010

1111
---
1212

13+
## [1.1.4] - 2022-08-26
14+
15+
### Changes
16+
17+
- The generate-manual plugin now defaults to creating single page manuals. The
18+
`--single-page` flag has been replaced with `--multi-page` to restore the
19+
previous default functionality. ([#472])
20+
21+
*Migration:* Update scripts that invoked generate-manual without
22+
`--single-page` to include `--multi-page` and update scripts that invoked
23+
generate-manual with `--single-page` to omit the flag.
24+
25+
- The "experimental" prefix from the generate-manual plugin has been removed.
26+
([#475])
27+
28+
*Migration:* Update scripts to invoke the generate manual plugin via
29+
`swift package generate-manual` instead of
30+
`swift package plugin experimental-generate-manual`.
31+
32+
### Fixes
33+
34+
- The generate-manual plugin is correctly declared as a product, making the
35+
plugin visible to clients. ([#456])
36+
- The generate-manual plugin's `--authors` arguments are now correctly passed to
37+
the underlying generation tool. ([#471])
38+
- Manuals generated by the generate-manual plugin now include the option's value
39+
names and do not include value names for flags. ([#473])
40+
- Built-in flags such as `--help` and `--version` are now correctly marked as
41+
optional fixing some generated content which indicated the flags are always
42+
required. ([#474])
43+
- Value descriptions are now correctly derived for types which are
44+
`ExpressibleByArgument` and `RawRepresentable` by `String`. Help menus will
45+
now display valid default values for such types. ([#476])
46+
47+
The 1.1.4 release includes contributions from [ian-twilightcoder],
48+
[MarcoEidinger], and [rauhul]. Thank you!
49+
1350
## [1.1.3] - 2022-06-23
1451

1552
### Additions
1653

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

2259
### Fixes
2360

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

655692
<!-- Link references for releases -->
656693

657-
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.1.3...HEAD
694+
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.1.4...HEAD
695+
[1.1.4]: https://github.com/apple/swift-argument-parser/compare/1.1.3...1.1.4
658696
[1.1.3]: https://github.com/apple/swift-argument-parser/compare/1.1.2...1.1.3
659697
[1.1.2]: https://github.com/apple/swift-argument-parser/compare/1.1.1...1.1.2
660698
[1.1.1]: https://github.com/apple/swift-argument-parser/compare/1.1.0...1.1.1
@@ -718,6 +756,13 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
718756
[#436]: https://github.com/apple/swift-argument-parser/pull/436
719757
[#443]: https://github.com/apple/swift-argument-parser/pull/443
720758
[#445]: https://github.com/apple/swift-argument-parser/pull/445
759+
[#456]: https://github.com/apple/swift-argument-parser/pull/456
760+
[#471]: https://github.com/apple/swift-argument-parser/pull/471
761+
[#472]: https://github.com/apple/swift-argument-parser/pull/472
762+
[#473]: https://github.com/apple/swift-argument-parser/pull/473
763+
[#474]: https://github.com/apple/swift-argument-parser/pull/474
764+
[#475]: https://github.com/apple/swift-argument-parser/pull/475
765+
[#476]: https://github.com/apple/swift-argument-parser/pull/476
721766

722767
<!-- Link references for contributors -->
723768

@@ -745,6 +790,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
745790
[gmittert]: https://github.com/apple/swift-argument-parser/commits?author=gmittert
746791
[griffin-stewie]: https://github.com/apple/swift-argument-parser/commits?author=griffin-stewie
747792
[iainsmith]: https://github.com/apple/swift-argument-parser/commits?author=iainsmith
793+
[ian-twilightcoder]: https://github.com/apple/swift-argument-parser/commits?author=ian-twilightcoder
748794
[ibrahimoktay]: https://github.com/apple/swift-argument-parser/commits?author=ibrahimoktay
749795
[imxieyi]: https://github.com/apple/swift-argument-parser/commits?author=imxieyi
750796
[IngmarStein]: https://github.com/apple/swift-argument-parser/commits?author=IngmarStein
@@ -762,6 +808,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
762808
[Lantua]: https://github.com/apple/swift-argument-parser/commits?author=Lantua
763809
[lorentey]: https://github.com/apple/swift-argument-parser/commits?author=lorentey
764810
[LucianoPAlmeida]: https://github.com/apple/swift-argument-parser/commits?author=LucianoPAlmeida
811+
[MarcoEidinger]: https://github.com/apple/swift-argument-parser/commits?author=MarcoEidinger
765812
[MartinP7r]: https://github.com/apple/swift-argument-parser/commits?author=MartinP7r
766813
[MaxDesiatov]: https://github.com/apple/swift-argument-parser/commits?author=MaxDesiatov
767814
[McNight]: https://github.com/apple/swift-argument-parser/commits?author=McNight

0 commit comments

Comments
 (0)