spf13/cobra
### [`v1.2.1`](https://togithub.com/spf13/cobra/releases/v1.2.1)
[Compare Source](https://togithub.com/spf13/cobra/compare/v1.2.0...v1.2.1)
##### Bug fixes
- Quickfix for [https://github.com/spf13/cobra/issues/1437](https://togithub.com/spf13/cobra/issues/1437) after v1.2.0 where parallel use of the `cmd.RegisterFlagCompletionFunc()` (and subsequent map) now works correctly and flag completions now work again
### [`v1.2.0`](https://togithub.com/spf13/cobra/releases/v1.2.0)
[Compare Source](https://togithub.com/spf13/cobra/compare/v1.1.3...v1.2.0)
### :stars: v1.2.0 - The completions release
Welcome to v1.2.0 of Cobra! This release focuses on code completions, several critical bug fixes, some documentation updates, and security bumps. Upgrading should be simple but note please take note of the introduction of completions V2 and their default use. The v1 completions library is still available, but will be *deprecated* in the future. Please open an issue with any problems!
***
#### New Features
- Automatically adds `completion` command for shell completions. If a `completion` command is already provided, uses that instead. This will *automatically* provide shell completions for bash, zsh, fish, and PowerShell [https://github.com/spf13/cobra/pull/1192](https://togithub.com/spf13/cobra/pull/1192)
- Users can configure the command auto creation:
- disable the creation of the completion command
- disable completion descriptions
- disable the `--no-descriptions` flag for "always on" completion descriptions
- Introduction of bash completions V2, a uniform completion approach which include completion descriptions. The V1 bash completions are still available *and will be deprecated* in a latter release - [https://github.com/spf13/cobra/pull/1146](https://togithub.com/spf13/cobra/pull/1146)
- Note that projects providing completion through a different command name (say a command named "complete") will continue to use v1 for their own command but will also provide cobra's implicit "completion" command which will use v2, unless of course, these projects take the time to disable the default "completion" command as noted above.
- Commands now support context being passed to completions - [https://github.com/spf13/cobra/pull/1265](https://togithub.com/spf13/cobra/pull/1265)
- An example can be found here: [https://github.com/spf13/cobra/pull/1265#issuecomment-734551031](https://togithub.com/spf13/cobra/pull/1265#issuecomment-734551031)
- Removed dependency on`mitchellh/go-homedir` in favor of core Go `os.UserHomeDir()` - https://github.com/spf13/cobra/commit/8eaca5f0f49ad747a0722d39dca7a75c34abd21a
#### Bug Fixes
- Fix trailing whitespace not being handled in powershell completion scripts [https://github.com/spf13/cobra/pull/1342](https://togithub.com/spf13/cobra/pull/1342)
- Bash completion variable leak fix [https://github.com/spf13/cobra/pull/1352](https://togithub.com/spf13/cobra/pull/1352)
- Fish shell completions correctly ignore trailing empty lines [https://github.com/spf13/cobra/pull/1284](https://togithub.com/spf13/cobra/pull/1284)
- PowerShell completions fix for "no file comp directive" - [https://github.com/spf13/cobra/pull/1363](https://togithub.com/spf13/cobra/pull/1363)
- Custom completions now correctly handle multiple shorthand flags together - [https://github.com/spf13/cobra/pull/1258](https://togithub.com/spf13/cobra/pull/1258)
- zsh completions now correctly handle `ShellDirectiveCompletionNoSpace` and file completion all the time - [https://github.com/spf13/cobra/pull/1213](https://togithub.com/spf13/cobra/pull/1213)
- Multiple fixes / improvements to the fish shell support - [https://github.com/spf13/cobra/pull/1249](https://togithub.com/spf13/cobra/pull/1249)
- Fix home directory config not loading correctly - [https://github.com/spf13/cobra/pull/1282](https://togithub.com/spf13/cobra/pull/1282)
- Fix for `RegisterFlagCompletionFunc` as a global var not working in multi-threaded programs: [https://github.com/spf13/cobra/pull/1423](https://togithub.com/spf13/cobra/pull/1423)
- Custom completions correctly do not complete flags after args when interspersed is false [#1308](https://togithub.com/spf13/cobra/issues/1308)
#### Testing
- Deprecated Travis CI. Now fully using Github Actions - https://github.com/spf13/cobra/commit/d0f318d45bdb46e3c1bc314c6096674426f1a620
- Added test cases and enhancements (thank you to everyone for taking the time to add tests to your PRs!)
- Shoutout to [@marckhouzam](https://togithub.com/marckhouzam) and [@Luap99](https://togithub.com/Luap99) for their hard work on a cobra command completions testing library. [Check out the repo here!](https://togithub.com/marckhouzam/cobra-completion-testing)
#### Security
- Bump viper to 1.8.1. This corrects several issues with vulnerabilities existing in the dependency tree - [https://github.com/spf13/cobra/pull/1433](https://togithub.com/spf13/cobra/pull/1433)
#### Other
- Add PR labeler with pull_request_target to enable tests to run from forks - [https://github.com/spf13/cobra/pull/1338](https://togithub.com/spf13/cobra/pull/1338)
- CI using MSYS2 windows machines pull latest - [https://github.com/spf13/cobra/pull/1366](https://togithub.com/spf13/cobra/pull/1366)
- Multiple small fixes to spelling / documentation - [https://github.com/spf13/cobra/pull/1349](https://togithub.com/spf13/cobra/pull/1349) [https://github.com/spf13/cobra/pull/1417](https://togithub.com/spf13/cobra/pull/1417) [https://github.com/spf13/cobra/pull/1434](https://togithub.com/spf13/cobra/pull/1434)
**Thank you to *all* our amazing contributors :snake::rocket:**
### [`v1.1.3`](https://togithub.com/spf13/cobra/blob/master/CHANGELOG.md#v113)
[Compare Source](https://togithub.com/spf13/cobra/compare/v1.1.2...v1.1.3)
- **Fix:** release-branch.cobra1.1 only: Revert "Deprecate Go < 1.14" to maintain backward compatibility
### [`v1.1.2`](https://togithub.com/spf13/cobra/blob/master/CHANGELOG.md#v112)
[Compare Source](https://togithub.com/spf13/cobra/compare/v1.1.1...v1.1.2)
##### Notable Changes
- Bump license year to 2021 in golden files ([#1309](https://togithub.com/spf13/cobra/issues/1309)) [@Bowbaq](https://togithub.com/Bowbaq)
- Enhance PowerShell completion with custom comp ([#1208](https://togithub.com/spf13/cobra/issues/1208)) [@Luap99](https://togithub.com/Luap99)
- Update gopkg.in/yaml.v2 to v2.4.0: The previous breaking change in yaml.v2 v2.3.0 has been reverted, see [go-yaml/yaml#670](https://togithub.com/go-yaml/yaml/issues/670)
- Documentation readability improvements ([#1228](https://togithub.com/spf13/cobra/issues/1228) etc.) [@zaataylor](https://togithub.com/zaataylor) etc.
- Use golangci-lint: Repair warnings and errors resulting from linting ([#1044](https://togithub.com/spf13/cobra/issues/1044)) [@umarcor](https://togithub.com/umarcor)
### [`v1.1.1`](https://togithub.com/spf13/cobra/blob/master/CHANGELOG.md#v111)
[Compare Source](https://togithub.com/spf13/cobra/compare/v1.1.0...v1.1.1)
- **Fix:** yaml.v2 2.3.0 contained a unintended breaking change. This release reverts to yaml.v2 v2.2.8 which has recent critical CVE fixes, but does not have the breaking changes. See [https://github.com/spf13/cobra/pull/1259](https://togithub.com/spf13/cobra/pull/1259) for context.
- **Fix:** correct internal formatting for go-md2man v2 (which caused man page generation to be broken). See [https://github.com/spf13/cobra/issues/1049](https://togithub.com/spf13/cobra/issues/1049) for context.
### [`v1.1.0`](https://togithub.com/spf13/cobra/blob/master/CHANGELOG.md#v110)
[Compare Source](https://togithub.com/spf13/cobra/compare/v1.0.0...v1.1.0)
##### Notable Changes
- Extend Go completions and revamp zsh comp ([#1070](https://togithub.com/spf13/cobra/issues/1070))
- Fix man page doc generation - no auto generated tag when `cmd.DisableAutoGenTag = true` ([#1104](https://togithub.com/spf13/cobra/issues/1104)) [@jpmcb](https://togithub.com/jpmcb)
- Add completion for help command ([#1136](https://togithub.com/spf13/cobra/issues/1136))
- Complete subcommands when TraverseChildren is set ([#1171](https://togithub.com/spf13/cobra/issues/1171))
- Fix stderr printing functions ([#894](https://togithub.com/spf13/cobra/issues/894))
- fix: fish output redirection ([#1247](https://togithub.com/spf13/cobra/issues/1247))
Configuration
📅 Schedule: At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, click this checkbox.
This PR contains the following updates:
v1.0.0->v1.2.1Release Notes
spf13/cobra
### [`v1.2.1`](https://togithub.com/spf13/cobra/releases/v1.2.1) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.2.0...v1.2.1) ##### Bug fixes - Quickfix for [https://github.com/spf13/cobra/issues/1437](https://togithub.com/spf13/cobra/issues/1437) after v1.2.0 where parallel use of the `cmd.RegisterFlagCompletionFunc()` (and subsequent map) now works correctly and flag completions now work again ### [`v1.2.0`](https://togithub.com/spf13/cobra/releases/v1.2.0) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.1.3...v1.2.0) ### :stars: v1.2.0 - The completions release Welcome to v1.2.0 of Cobra! This release focuses on code completions, several critical bug fixes, some documentation updates, and security bumps. Upgrading should be simple but note please take note of the introduction of completions V2 and their default use. The v1 completions library is still available, but will be *deprecated* in the future. Please open an issue with any problems! *** #### New Features - Automatically adds `completion` command for shell completions. If a `completion` command is already provided, uses that instead. This will *automatically* provide shell completions for bash, zsh, fish, and PowerShell [https://github.com/spf13/cobra/pull/1192](https://togithub.com/spf13/cobra/pull/1192) - Users can configure the command auto creation: - disable the creation of the completion command - disable completion descriptions - disable the `--no-descriptions` flag for "always on" completion descriptions - Introduction of bash completions V2, a uniform completion approach which include completion descriptions. The V1 bash completions are still available *and will be deprecated* in a latter release - [https://github.com/spf13/cobra/pull/1146](https://togithub.com/spf13/cobra/pull/1146) - Note that projects providing completion through a different command name (say a command named "complete") will continue to use v1 for their own command but will also provide cobra's implicit "completion" command which will use v2, unless of course, these projects take the time to disable the default "completion" command as noted above. - Commands now support context being passed to completions - [https://github.com/spf13/cobra/pull/1265](https://togithub.com/spf13/cobra/pull/1265) - An example can be found here: [https://github.com/spf13/cobra/pull/1265#issuecomment-734551031](https://togithub.com/spf13/cobra/pull/1265#issuecomment-734551031) - Removed dependency on`mitchellh/go-homedir` in favor of core Go `os.UserHomeDir()` - https://github.com/spf13/cobra/commit/8eaca5f0f49ad747a0722d39dca7a75c34abd21a #### Bug Fixes - Fix trailing whitespace not being handled in powershell completion scripts [https://github.com/spf13/cobra/pull/1342](https://togithub.com/spf13/cobra/pull/1342) - Bash completion variable leak fix [https://github.com/spf13/cobra/pull/1352](https://togithub.com/spf13/cobra/pull/1352) - Fish shell completions correctly ignore trailing empty lines [https://github.com/spf13/cobra/pull/1284](https://togithub.com/spf13/cobra/pull/1284) - PowerShell completions fix for "no file comp directive" - [https://github.com/spf13/cobra/pull/1363](https://togithub.com/spf13/cobra/pull/1363) - Custom completions now correctly handle multiple shorthand flags together - [https://github.com/spf13/cobra/pull/1258](https://togithub.com/spf13/cobra/pull/1258) - zsh completions now correctly handle `ShellDirectiveCompletionNoSpace` and file completion all the time - [https://github.com/spf13/cobra/pull/1213](https://togithub.com/spf13/cobra/pull/1213) - Multiple fixes / improvements to the fish shell support - [https://github.com/spf13/cobra/pull/1249](https://togithub.com/spf13/cobra/pull/1249) - Fix home directory config not loading correctly - [https://github.com/spf13/cobra/pull/1282](https://togithub.com/spf13/cobra/pull/1282) - Fix for `RegisterFlagCompletionFunc` as a global var not working in multi-threaded programs: [https://github.com/spf13/cobra/pull/1423](https://togithub.com/spf13/cobra/pull/1423) - Custom completions correctly do not complete flags after args when interspersed is false [#1308](https://togithub.com/spf13/cobra/issues/1308) #### Testing - Deprecated Travis CI. Now fully using Github Actions - https://github.com/spf13/cobra/commit/d0f318d45bdb46e3c1bc314c6096674426f1a620 - Added test cases and enhancements (thank you to everyone for taking the time to add tests to your PRs!) - Shoutout to [@marckhouzam](https://togithub.com/marckhouzam) and [@Luap99](https://togithub.com/Luap99) for their hard work on a cobra command completions testing library. [Check out the repo here!](https://togithub.com/marckhouzam/cobra-completion-testing) #### Security - Bump viper to 1.8.1. This corrects several issues with vulnerabilities existing in the dependency tree - [https://github.com/spf13/cobra/pull/1433](https://togithub.com/spf13/cobra/pull/1433) #### Other - Add PR labeler with pull_request_target to enable tests to run from forks - [https://github.com/spf13/cobra/pull/1338](https://togithub.com/spf13/cobra/pull/1338) - CI using MSYS2 windows machines pull latest - [https://github.com/spf13/cobra/pull/1366](https://togithub.com/spf13/cobra/pull/1366) - Multiple small fixes to spelling / documentation - [https://github.com/spf13/cobra/pull/1349](https://togithub.com/spf13/cobra/pull/1349) [https://github.com/spf13/cobra/pull/1417](https://togithub.com/spf13/cobra/pull/1417) [https://github.com/spf13/cobra/pull/1434](https://togithub.com/spf13/cobra/pull/1434) **Thank you to *all* our amazing contributors :snake::rocket:** ### [`v1.1.3`](https://togithub.com/spf13/cobra/blob/master/CHANGELOG.md#v113) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.1.2...v1.1.3) - **Fix:** release-branch.cobra1.1 only: Revert "Deprecate Go < 1.14" to maintain backward compatibility ### [`v1.1.2`](https://togithub.com/spf13/cobra/blob/master/CHANGELOG.md#v112) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.1.1...v1.1.2) ##### Notable Changes - Bump license year to 2021 in golden files ([#1309](https://togithub.com/spf13/cobra/issues/1309)) [@Bowbaq](https://togithub.com/Bowbaq) - Enhance PowerShell completion with custom comp ([#1208](https://togithub.com/spf13/cobra/issues/1208)) [@Luap99](https://togithub.com/Luap99) - Update gopkg.in/yaml.v2 to v2.4.0: The previous breaking change in yaml.v2 v2.3.0 has been reverted, see [go-yaml/yaml#670](https://togithub.com/go-yaml/yaml/issues/670) - Documentation readability improvements ([#1228](https://togithub.com/spf13/cobra/issues/1228) etc.) [@zaataylor](https://togithub.com/zaataylor) etc. - Use golangci-lint: Repair warnings and errors resulting from linting ([#1044](https://togithub.com/spf13/cobra/issues/1044)) [@umarcor](https://togithub.com/umarcor) ### [`v1.1.1`](https://togithub.com/spf13/cobra/blob/master/CHANGELOG.md#v111) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.1.0...v1.1.1) - **Fix:** yaml.v2 2.3.0 contained a unintended breaking change. This release reverts to yaml.v2 v2.2.8 which has recent critical CVE fixes, but does not have the breaking changes. See [https://github.com/spf13/cobra/pull/1259](https://togithub.com/spf13/cobra/pull/1259) for context. - **Fix:** correct internal formatting for go-md2man v2 (which caused man page generation to be broken). See [https://github.com/spf13/cobra/issues/1049](https://togithub.com/spf13/cobra/issues/1049) for context. ### [`v1.1.0`](https://togithub.com/spf13/cobra/blob/master/CHANGELOG.md#v110) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.0.0...v1.1.0) ##### Notable Changes - Extend Go completions and revamp zsh comp ([#1070](https://togithub.com/spf13/cobra/issues/1070)) - Fix man page doc generation - no auto generated tag when `cmd.DisableAutoGenTag = true` ([#1104](https://togithub.com/spf13/cobra/issues/1104)) [@jpmcb](https://togithub.com/jpmcb) - Add completion for help command ([#1136](https://togithub.com/spf13/cobra/issues/1136)) - Complete subcommands when TraverseChildren is set ([#1171](https://togithub.com/spf13/cobra/issues/1171)) - Fix stderr printing functions ([#894](https://togithub.com/spf13/cobra/issues/894)) - fix: fish output redirection ([#1247](https://togithub.com/spf13/cobra/issues/1247))Configuration
📅 Schedule: At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by WhiteSource Renovate. View repository job log here.