Skip to content

Commit

Permalink
docs: update changelog.md and releasenotes for 3.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
natemcmaster committed Nov 7, 2020
1 parent 2d6365e commit e621724
Show file tree
Hide file tree
Showing 4 changed files with 83 additions and 4 deletions.
58 changes: 55 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,54 @@

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

* [@scott-xu]: feature: add API for setting default value on options and arguments, and display them in help text ([#389])

[#389]: https://github.com/natemcmaster/CommandLineUtils/pull/389

## [v3.1.0](https://github.com/natemcmaster/CommandLineUtils/compare/v3.0.0...v3.1.0)

### Improvements

* [@scott-xu]: Show allowed values in help text ([#369])
* [@scott-xu]: Generic Hosting: add overload of RunCommandLineApplicationAsync to support configuring of CommandLineApplication<T> ([#363])
* [@danielmeza]: implement API on host builder to fetch CommandLineContext from non DI contexts ([#368])

### Bug fixes
* [@natemcmaster]: ensure clustering options is detected correctly when subcommands added via AddSubcommand ([#393])
* [@scott-xu]: make UnrecognizedArgumentHandling per command scope ([#371])
* [@scott-xu]: show allowed values in help text correctly when multiple `AllowedValuesAttribute` are used ([#375])
* [@scott-xu]: show allowed values in help text for Nullable/ValueTuple<bool,T> option/argument ([#390])
* [@scott-xu]: update help text to show allowed values from `AllowedValues` attribute instead of Enum values ([#391])

### Docs
* [@chaami]: Fix Readme.md on Prompt.GetYesNo ([#402])
* [@cuperman007] docs: added using statements to code sample in index.md ([#384])
* [@scott-xu]: Fix broken links in docs ([#377])
* [@scott-xu]: cleanup: add a period to end sentences for built-in descriptions ([#364])

### Other

* [@natemcmaster]: Change default branch to 'main' ([#373])
* [@natemcmaster]: Stop code signing binaries and packages ([#379])
* [@natemcmaster]: add dotnet-format to CI, and other code/project file cleanups


[#363]: https://github.com/natemcmaster/CommandLineUtils/pull/363
[#364]: https://github.com/natemcmaster/CommandLineUtils/pull/364
[#367]: https://github.com/natemcmaster/CommandLineUtils/pull/367
[#368]: https://github.com/natemcmaster/CommandLineUtils/pull/368
[#369]: https://github.com/natemcmaster/CommandLineUtils/pull/369
[#371]: https://github.com/natemcmaster/CommandLineUtils/pull/371
[#373]: https://github.com/natemcmaster/CommandLineUtils/pull/373
[#375]: https://github.com/natemcmaster/CommandLineUtils/pull/375
[#377]: https://github.com/natemcmaster/CommandLineUtils/pull/377
[#379]: https://github.com/natemcmaster/CommandLineUtils/pull/379
[#384]: https://github.com/natemcmaster/CommandLineUtils/pull/384
[#390]: https://github.com/natemcmaster/CommandLineUtils/pull/390
[#391]: https://github.com/natemcmaster/CommandLineUtils/pull/391
[#393]: https://github.com/natemcmaster/CommandLineUtils/pull/393
[#402]: https://github.com/natemcmaster/CommandLineUtils/pull/402

## [v3.0.0](https://github.com/natemcmaster/CommandLineUtils/compare/v2.6.0...v3.0.0)

### Improvements
Expand Down Expand Up @@ -433,25 +481,29 @@ Other:

[@atifaziz]: https://github.com/atifaziz
[@atruskie]: https://github.com/atruskie
[@bording]: https://github.com/bording
[@bjorg]: https://github.com/bjorg
[@bording]: https://github.com/bording
[@chaami]: https://github.com/chaami
[@couven92]: https://github.com/couven92
[@cuperman007]: https://github.com/cuperman007
[@danielmeza]: https://github.com/danielmeza
[@demosdemon]: https://github.com/demosdemon
[@EricStG]: https://github.com/EricStG
[@ejball]: https://github.com/ejball
[@EricStG]: https://github.com/EricStG
[@handcraftedsource]: https://github.com/handcraftedsource
[@IanG]: https://github.com/IanG
[@jcaillon]: https://github.com/jcaillon
[@jerriep]: https://github.com/jerriep
[@kant2002]: https://github.com/kant2002
[@kyle-rader]: https://github.com/kyle-rader
[@lucastheisen]: https://github.com/lucastheisen
[@liamdawson]: https://github.com/liamdawson
[@lucastheisen]: https://github.com/lucastheisen
[@lvermeulen]: https://github.com/lvermeulen
[@MadbHatter]: https://github.com/MadbHatter
[@mpipo]: https://github.com/mpipo
[@rlvandaveer]: https://github.com/rlvandaveer
[@rmcc13]: https://github.com/rmcc13
[@scott-xu]: https://github.com/scott-xu
[@SeanFeldman]: https://github.com/SeanFeldman
[@sebastienros]: https://github.com/sebastienros
[@SteveBenz]: https://github.com/SteveBenz
Expand Down
2 changes: 1 addition & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@

<PropertyGroup>
<VersionPrefix>3.1.0</VersionPrefix>
<VersionSuffix>beta</VersionSuffix>
<VersionSuffix>rc</VersionSuffix>
<IncludePreReleaseLabelInPackageVersion Condition="'$(IsStableBuild)' != 'true'">true</IncludePreReleaseLabelInPackageVersion>
<BuildNumber Condition=" '$(BuildNumber)' == '' ">$(BUILD_NUMBER)</BuildNumber>
<BuildNumber Condition=" '$(BuildNumber)' == '' ">0</BuildNumber>
Expand Down
22 changes: 22 additions & 0 deletions src/CommandLineUtils/releasenotes.props
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
<Project>
<PropertyGroup>
<PackageReleaseNotes Condition="$(VersionPrefix.StartsWith('3.1.'))">
Improvements:
* @scott-xu: Show allowed values in help text (#369)

Bug fixes:
* @natemcmaster: ensure clustering options is detected correctly when subcommands added via AddSubcommand (#393)
* @scott-xu: make UnrecognizedArgumentHandling per command scope (#371)
* @scott-xu: show allowed values in help text correctly when multiple AllowedValuesAttribute are used (#375)
* @scott-xu: show allowed values in help text for Nullable/ValueTuple&lt;bool,T&gt; option/argument (#390)
* @scott-xu: update help text to show allowed values from AllowedValues attribute instead of Enum values (#391)

Docs:
* @chaami: Fix Readme.md on Prompt.GetYesNo (#402)
* @cuperman007 docs: added using statements to code sample in index.md (#384)
* @scott-xu: Fix broken links in docs (#377)
* @scott-xu: cleanup: add a period to end sentences for built-in descriptions (#364)

Other:
* @natemcmaster: Stop code signing binaries and packages (#379)
* @natemcmaster: Change default project branch to 'main' (#373)
* @natemcmaster: add dotnet-format to CI, and other code/project file cleanups
</PackageReleaseNotes>
<PackageReleaseNotes Condition="$(VersionPrefix.StartsWith('3.0.'))">
Improvements:
* @AlexeyEvlampiev - implement support for GUID command line options (#333) and any other type that TypeConverter supports (#62)
Expand Down
5 changes: 5 additions & 0 deletions src/Hosting.CommandLine/releasenotes.props
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
<Project>
<PropertyGroup>
<PackageReleaseNotes Condition="$(VersionPrefix.StartsWith('3.1.'))">
Improvements:
* @scott-xu: feature: add overload of RunCommandLineApplicationAsync to support configuring of CommandLineApplication (#363)
* @danielmeza: feature: implement API on host builder to fetch CommandLineContext from non DI contexts (#368)
</PackageReleaseNotes>
<PackageReleaseNotes Condition="$(VersionPrefix.StartsWith('3.0.'))">
Features:
* @vpkopylov - Added support for using the 'builder API' by calling .RunCommandLineApplicationAsync(args, app => { })
Expand Down

0 comments on commit e621724

Please sign in to comment.