Update module github.com/spf13/cobra to v1.8.1 #17
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
v1.0.0
->v1.8.1
Release Notes
spf13/cobra (github.com/spf13/cobra)
v1.8.1
Compare Source
✨ Features
🐛 Bug fixes
🔧 Maintenance
🧪 Testing & CI/CD
✏️ Documentation
New Contributors
Thank you everyone who contributed to this release and all your hard work! Cobra and this community would never be possible without all of you!!!! 🐍
Full Changelog: spf13/cobra@v1.8.0...v1.8.1
v1.8.0
Compare Source
✨ Features
MarkFlagsOneRequired
API for flags which can be used to mark a flag group as required and cause command failure if at least one is not used when invoked.SetErrPrefix
andErrPrefix
APIs on theCommand
struct to allow for setting a custom prefix for errors🐛 Bug fixes
🔧 Maintenance
🧪 Testing & CI/CD
✏️ Documentation
Thank you everyone who contributed to this release and all your hard work! Cobra and this community would never be possible without all of you!!!! 🐍
Full Changelog: spf13/cobra@v1.7.0...v1.8.0
v1.7.0
Compare Source
✨ Features
bash
,zsh
,pwsh
, &fish
: @h4ck3rk3y #1903🐛 Bug fixes
template
import variable name: @yashLadha #1879🧪 Testing & CI/CD
🔧 Maintenance
stale.yaml
mispellings: @enrichman #1863Vitess
andArewefastyet
to projects using cobra: @frouioui #1932✏️ Documentation
MarkFlagsMutuallyExclusive
example in user guide: @janhn #1904shell_completions.md
: @gusega #1907This release contains several long running fixes, improvements to powershell completions, and further optimizations for completions.
Thank you everyone who contributed to this release and all your hard work! Cobra and this community would never be possible without all of you! 🐍
Full changelog: spf13/cobra@v1.6.1...v1.7.0
v1.6.1
Compare Source
Bug fixes 🐛
AddGroup
isn't called beforeAddCommand(my-sub-command)
is executed. This can happen within more complex cobra file structures that have many differentinit
s to be executed. Now, the check for groups has been moved toExecuteC
and provides more flexibility when working with grouped commands - @marckhouzam (and shout out to @aawsome, @andig and @KINGSABRI for a deep investigation into this! 👏🏼)v1.6.0
Compare Source
Summer 2022 Release
Some exciting changes make their way to Cobra! Command completions continue to get better and better (including adding
--help
and--version
automatic flags to the completions list). Grouping is now possible in your help output as well! And you can now use theOnFinalize
method to cleanup things when all "work" is done. Checkout the full changelog below:Features 🌠
ValidateRequiredFlags
andValidateFlagGroups
: @skeetwu #1760--version
flag to help output: @fnickels #1707--help
and--version
flag in completions: @marckhouzam #1813OnFinalize
method: @yann-soubeyrand #1788InitDefaultcompletionCmd
public: @gssbzn #1467Deprecation 👎🏼
ExactValidArgs
is deprecated (but not being removed entirely). This is abit nuanced, so checkout #1643 for further information and the updateduser_guide.md
on how this may affect you (and how you can take advantage of the correct behavior in the validators): @umarcor #1643Bug fixes 🐛
activeHelp
length check syntax: @scop #1762see_also
for yaml documentation: @zregvart #1771Dependencies 🗳️
gopkg.in/yaml.v3
: @tklauser #1766Testing 🤔
action/setup-go
cache: @umarcor #1783workflow_dispatch
to CI actions: @umarcor #1387Docs ✏️
SetContext
documentation: @katexochen #1748go install
for binary: @marckhouzam #1726Misc 💭
exempt
yaml keys: @jpmcb #1800Note: Per #1804, we will be moving away from "seasonal" releases and doing more generic point release targets. Continue to track the milestones and issues in the
spf13/cobra
GitHub repository for more information!Great work everyone! Cobra would never be possible without your contributions! 🐍
Full Changelog: spf13/cobra@v1.5.0...v1.6.0
v1.5.0
Compare Source
Spring 2022 Release 🌥️
Hello everyone! Welcome to another release of cobra. Completions continue to get better and better. This release adds a few really cool new features. We also continue to patch versions of our dependencies as they become available via dependabot. Happy coding!
Active help 👐🏼
Shout out to @marckhouzam for a big value add: Active Help https://github.com/spf13/cobra/pull/1482. With active help, a program can provide some inline warnings or hints for users as they hit tab. Now, your CLIs can be even more intuitive to use!
Currently active help is only supported for bash V2 and zsh. Marc wrote a whole guide on how to do this, so make sure to give it a good read to learn how you can add this to your cobra code! https://github.com/spf13/cobra/blob/master/active_help.md
Group flags 🧑🏼🤝🧑🏼
Cobra now has the ability to mark flags as required or exclusive as a group. Shout out to our newest maintainer @johnSchnake for this! https://github.com/spf13/cobra/pull/1654 Let's say you have a
username
flag that MUST be partnered with apassword
flag. Well, now, you can enforce those as being required together:Flags may also be marked as "mutally exclusive" with the
MarkFlagsMutuallyExclusive(string, string ... )
command API. Refer to our user guide documentation for further info!Completions 👀
Documentation 📝
CHANGELOG.md
as it isn't updated - @johnSchnake https://github.com/spf13/cobra/pull/1634shell_completion.md
- @danieldn https://github.com/spf13/cobra/pull/1678Testing & CI ⚙️
RICHGO_FORCE_COLOR
- @umarcor https://github.com/spf13/cobra/pull/1647stale-bot
settings - @jpmcb https://github.com/spf13/cobra/pull/1609Beep boop, bot commits 🤖
Misc 💭
errors.Is()
to check for errors - @Luap99 https://github.com/spf13/cobra/pull/1730Shoutout to ALL our contributors (and all the new first time contributors!!) - great work everyone!! Cobra and it's huge impact wouldn't be possible without you 👏🏼 🚀 🐍
Full Changelog: spf13/cobra@v1.4.0...v1.5.0
v1.4.0
Compare Source
Winter 2022 Release ❄️
Another season, another release!
Goodbye viper! 🐍 🚀
The core Cobra library no longer requires Viper and all of its indirect dependencies. This means that Cobra's dependency tree has been drastically thinned! The Viper dependency was included because of the
cobra
CLI generation tool. This tool has migrated tospf13/cobra-cli
.It's pretty unlikely you were importing and using the bootstrapping CLI tool as part of your application (after all, it's just a tool to get going with core
cobra
).But if you were, replace occurrences of
with
And in your
go.mod
, you'll want to also include this dependency:Again, the maintainers do not anticipate this being a breaking change to users of the core
cobra
library, so minimal work should be required for users to integrate with this new release. Moreover, this means the dependency tree for your application using Cobra should no longer require dependencies that were inherited from Viper. Huzzah! 🥳If you'd like to read more
Documentation 📝
@latest
: https://github.com/spf13/cobra/pull/1576Other 💭
Shoutout to our awesome contributors helping to make this cobra release possible!!
@spf13 @marckhouzam @johnSchnake @jpmcb @liggitt @umarcor @hiljusti @marians @shyim @htroisi
v1.3.0
Compare Source
v1.3.0 - The Fall 2021 release 🍁
Completion fixes & enhancements 💇🏼
In
v1.2.0
, we introduced a new model for completions. Thanks to everyone for trying it, giving feedback, and providing numerous fixes! Continue to work with the new model as the old one (as noted in code comments) will be deprecated in a coming release.DisableFlagParsing
now triggers custom completions for flag names #1161help
completion formatting improvements & fixes #1444help
example: short desc are now capitalized and removes extra spacing from long description #1455menu-complete
,menu-complete-backward
andinsert-completions
. These descriptions are now purposefully removed in support of this model. #1509~/.cobra.yaml
. Log messageUsing config file: ~/.cobra.yaml
now printed to stderr #1510completion
command #1541__complete
command for programs without subcommands #1563Generator changes ⚙️
Thanks to @spf13 for providing a number of changes to the Cobra generator tool, streamlining it for new users!
none
New Features ⭐
MatchAll
allows combining several PositionalArgs to work in concert. This now allows for enabling composingPositionalArgs
#896Bug Fixes 🐛
init
boilerplates #1463 #1552 #1557Testing 👀
args_test
#1426golangci-lint
github action #1477Security 🔏
v1.10.0
viper
: https://github.com/spf13/cobra/issues/1538. This will be patched in a future releaseDocumentation 📝
projects_using_cobra.md
file: #1377 #1501 #1454--author
flag is specified #1009shell_completions.md
has an easier to use snippet for copying and pasting shell completions #1372Other 💭
cpuguy83/go-md2man
to v2.0.1 #1460lesser
typo from the GPL-2.0 license #880Thank you to all our amazing contributors ⭐🐍🚀
v1.2.1
Compare Source
Bug fixes
cmd.RegisterFlagCompletionFunc()
(and subsequent map) now works correctly and flag completions now work againv1.2.0
: - The completions releaseCompare Source
🌠 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 please take note of the introduction of bash 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
completion
command for shell completions. If acompletion
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--no-descriptions
flag for "always on" completion descriptionsmitchellh/go-homedir
in favor of core Goos.UserHomeDir()
- spf13/cobra@8eaca5fBug Fixes
ShellDirectiveCompletionNoSpace
and file completion all the time - https://github.com/spf13/cobra/pull/1213RegisterFlagCompletionFunc
as a global var not working in multi-threaded programs: https://github.com/spf13/cobra/pull/1423Testing
Security
Other
Thank you to all our amazing contributors 🐍🚀
v1.1.3
Compare Source
release-branch.cobra1.1
only: Revert "Deprecate Go < 1.14" to maintain backward compatibilityv1.1.2
Compare Source
Notable Changes
v1.1.1
Compare Source
v1.1.0
Compare Source
Notable Changes
cmd.DisableAutoGenTag = true
(#1104)Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - 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 Renovate Bot.