This PR contains the following updates:
| Package | Type | Update | Change |
|---|---|---|---|
| github.com/spf13/cobra | require | minor | v1.1.3
-> v1.2.0
|
Release Notes
spf13/cobra
Compare Source
: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
- 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
- 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
- An example can be found here: https://github.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
- Bash completion variable leak fix https://github.com/spf13/cobra/pull/1352
- Fish shell completions correctly ignore trailing empty lines https://github.com/spf13/cobra/pull/1284
- PowerShell completions fix for "no file comp directive" - https://github.com/spf13/cobra/pull/1363
- Custom completions now correctly handle multiple shorthand flags together - https://github.com/spf13/cobra/pull/1258
- zsh completions now correctly handle
ShellDirectiveCompletionNoSpace
and file completion all the time - https://github.com/spf13/cobra/pull/1213
- Multiple fixes / improvements to the fish shell support - https://github.com/spf13/cobra/pull/1249
- Fix home directory config not loading correctly - https://github.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
- Custom completions correctly do not complete flags after args when interspersed is false #โ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 and @โLuap99 for their hard work on a cobra command completions testing library. Check out the repo here!
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
Other
- Add PR labeler with pull_request_target to enable tests to run from forks - https://github.com/spf13/cobra/pull/1338
- CI using MSYS2 windows machines pull latest - https://github.com/spf13/cobra/pull/1366
- Multiple small fixes to spelling / documentation - https://github.com/spf13/cobra/pull/1349 https://github.com/spf13/cobra/pull/1417 https://github.com/spf13/cobra/pull/1434
Thank you to all our amazing contributors :snake::rocket:
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, check this box.
This PR has been generated by WhiteSource Renovate. View repository job log here.