Skip to content

Commit e621724

Browse files
committed
docs: update changelog.md and releasenotes for 3.1 release
1 parent 2d6365e commit e621724

File tree

4 files changed

+83
-4
lines changed

4 files changed

+83
-4
lines changed

CHANGELOG.md

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,54 @@
22

33
[Unreleased changes](https://github.com/natemcmaster/CommandLineUtils/compare/v3.0.0...HEAD):
44

5+
* [@scott-xu]: feature: add API for setting default value on options and arguments, and display them in help text ([#389])
6+
7+
[#389]: https://github.com/natemcmaster/CommandLineUtils/pull/389
8+
9+
## [v3.1.0](https://github.com/natemcmaster/CommandLineUtils/compare/v3.0.0...v3.1.0)
10+
11+
### Improvements
12+
13+
* [@scott-xu]: Show allowed values in help text ([#369])
14+
* [@scott-xu]: Generic Hosting: add overload of RunCommandLineApplicationAsync to support configuring of CommandLineApplication<T> ([#363])
15+
* [@danielmeza]: implement API on host builder to fetch CommandLineContext from non DI contexts ([#368])
16+
17+
### Bug fixes
18+
* [@natemcmaster]: ensure clustering options is detected correctly when subcommands added via AddSubcommand ([#393])
19+
* [@scott-xu]: make UnrecognizedArgumentHandling per command scope ([#371])
20+
* [@scott-xu]: show allowed values in help text correctly when multiple `AllowedValuesAttribute` are used ([#375])
21+
* [@scott-xu]: show allowed values in help text for Nullable/ValueTuple<bool,T> option/argument ([#390])
22+
* [@scott-xu]: update help text to show allowed values from `AllowedValues` attribute instead of Enum values ([#391])
23+
24+
### Docs
25+
* [@chaami]: Fix Readme.md on Prompt.GetYesNo ([#402])
26+
* [@cuperman007] docs: added using statements to code sample in index.md ([#384])
27+
* [@scott-xu]: Fix broken links in docs ([#377])
28+
* [@scott-xu]: cleanup: add a period to end sentences for built-in descriptions ([#364])
29+
30+
### Other
31+
32+
* [@natemcmaster]: Change default branch to 'main' ([#373])
33+
* [@natemcmaster]: Stop code signing binaries and packages ([#379])
34+
* [@natemcmaster]: add dotnet-format to CI, and other code/project file cleanups
35+
36+
37+
[#363]: https://github.com/natemcmaster/CommandLineUtils/pull/363
38+
[#364]: https://github.com/natemcmaster/CommandLineUtils/pull/364
39+
[#367]: https://github.com/natemcmaster/CommandLineUtils/pull/367
40+
[#368]: https://github.com/natemcmaster/CommandLineUtils/pull/368
41+
[#369]: https://github.com/natemcmaster/CommandLineUtils/pull/369
42+
[#371]: https://github.com/natemcmaster/CommandLineUtils/pull/371
43+
[#373]: https://github.com/natemcmaster/CommandLineUtils/pull/373
44+
[#375]: https://github.com/natemcmaster/CommandLineUtils/pull/375
45+
[#377]: https://github.com/natemcmaster/CommandLineUtils/pull/377
46+
[#379]: https://github.com/natemcmaster/CommandLineUtils/pull/379
47+
[#384]: https://github.com/natemcmaster/CommandLineUtils/pull/384
48+
[#390]: https://github.com/natemcmaster/CommandLineUtils/pull/390
49+
[#391]: https://github.com/natemcmaster/CommandLineUtils/pull/391
50+
[#393]: https://github.com/natemcmaster/CommandLineUtils/pull/393
51+
[#402]: https://github.com/natemcmaster/CommandLineUtils/pull/402
52+
553
## [v3.0.0](https://github.com/natemcmaster/CommandLineUtils/compare/v2.6.0...v3.0.0)
654

755
### Improvements
@@ -433,25 +481,29 @@ Other:
433481

434482
[@atifaziz]: https://github.com/atifaziz
435483
[@atruskie]: https://github.com/atruskie
436-
[@bording]: https://github.com/bording
437484
[@bjorg]: https://github.com/bjorg
485+
[@bording]: https://github.com/bording
486+
[@chaami]: https://github.com/chaami
438487
[@couven92]: https://github.com/couven92
488+
[@cuperman007]: https://github.com/cuperman007
489+
[@danielmeza]: https://github.com/danielmeza
439490
[@demosdemon]: https://github.com/demosdemon
440-
[@EricStG]: https://github.com/EricStG
441491
[@ejball]: https://github.com/ejball
492+
[@EricStG]: https://github.com/EricStG
442493
[@handcraftedsource]: https://github.com/handcraftedsource
443494
[@IanG]: https://github.com/IanG
444495
[@jcaillon]: https://github.com/jcaillon
445496
[@jerriep]: https://github.com/jerriep
446497
[@kant2002]: https://github.com/kant2002
447498
[@kyle-rader]: https://github.com/kyle-rader
448-
[@lucastheisen]: https://github.com/lucastheisen
449499
[@liamdawson]: https://github.com/liamdawson
500+
[@lucastheisen]: https://github.com/lucastheisen
450501
[@lvermeulen]: https://github.com/lvermeulen
451502
[@MadbHatter]: https://github.com/MadbHatter
452503
[@mpipo]: https://github.com/mpipo
453504
[@rlvandaveer]: https://github.com/rlvandaveer
454505
[@rmcc13]: https://github.com/rmcc13
506+
[@scott-xu]: https://github.com/scott-xu
455507
[@SeanFeldman]: https://github.com/SeanFeldman
456508
[@sebastienros]: https://github.com/sebastienros
457509
[@SteveBenz]: https://github.com/SteveBenz

Directory.Build.props

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343

4444
<PropertyGroup>
4545
<VersionPrefix>3.1.0</VersionPrefix>
46-
<VersionSuffix>beta</VersionSuffix>
46+
<VersionSuffix>rc</VersionSuffix>
4747
<IncludePreReleaseLabelInPackageVersion Condition="'$(IsStableBuild)' != 'true'">true</IncludePreReleaseLabelInPackageVersion>
4848
<BuildNumber Condition=" '$(BuildNumber)' == '' ">$(BUILD_NUMBER)</BuildNumber>
4949
<BuildNumber Condition=" '$(BuildNumber)' == '' ">0</BuildNumber>

src/CommandLineUtils/releasenotes.props

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
<Project>
22
<PropertyGroup>
3+
<PackageReleaseNotes Condition="$(VersionPrefix.StartsWith('3.1.'))">
4+
Improvements:
5+
* @scott-xu: Show allowed values in help text (#369)
6+
7+
Bug fixes:
8+
* @natemcmaster: ensure clustering options is detected correctly when subcommands added via AddSubcommand (#393)
9+
* @scott-xu: make UnrecognizedArgumentHandling per command scope (#371)
10+
* @scott-xu: show allowed values in help text correctly when multiple AllowedValuesAttribute are used (#375)
11+
* @scott-xu: show allowed values in help text for Nullable/ValueTuple&lt;bool,T&gt; option/argument (#390)
12+
* @scott-xu: update help text to show allowed values from AllowedValues attribute instead of Enum values (#391)
13+
14+
Docs:
15+
* @chaami: Fix Readme.md on Prompt.GetYesNo (#402)
16+
* @cuperman007 docs: added using statements to code sample in index.md (#384)
17+
* @scott-xu: Fix broken links in docs (#377)
18+
* @scott-xu: cleanup: add a period to end sentences for built-in descriptions (#364)
19+
20+
Other:
21+
* @natemcmaster: Stop code signing binaries and packages (#379)
22+
* @natemcmaster: Change default project branch to 'main' (#373)
23+
* @natemcmaster: add dotnet-format to CI, and other code/project file cleanups
24+
</PackageReleaseNotes>
325
<PackageReleaseNotes Condition="$(VersionPrefix.StartsWith('3.0.'))">
426
Improvements:
527
* @AlexeyEvlampiev - implement support for GUID command line options (#333) and any other type that TypeConverter supports (#62)

src/Hosting.CommandLine/releasenotes.props

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
<Project>
22
<PropertyGroup>
3+
<PackageReleaseNotes Condition="$(VersionPrefix.StartsWith('3.1.'))">
4+
Improvements:
5+
* @scott-xu: feature: add overload of RunCommandLineApplicationAsync to support configuring of CommandLineApplication (#363)
6+
* @danielmeza: feature: implement API on host builder to fetch CommandLineContext from non DI contexts (#368)
7+
</PackageReleaseNotes>
38
<PackageReleaseNotes Condition="$(VersionPrefix.StartsWith('3.0.'))">
49
Features:
510
* @vpkopylov - Added support for using the 'builder API' by calling .RunCommandLineApplicationAsync(args, app => { })

0 commit comments

Comments
 (0)