Update module github.com/spf13/cobra to v1.8.1 #242
Conversation
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #242 +/- ##
==========================================
+ Coverage 40.58% 42.85% +2.26%
==========================================
Files 18 18
Lines 441 518 +77
==========================================
+ Hits 179 222 +43
- Misses 242 275 +33
- Partials 20 21 +1 ☔ View full report in Codecov by Sentry. |
renovate
bot
force-pushed
the
renovate/github.com-spf13-cobra-1.x
branch
from
f312e0a
to
45312eb
Compare
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/github.com-spf13-cobra-1.x
branch
from
45312eb
to
efbc685
Compare
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/github.com-spf13-cobra-1.x
branch
from
efbc685
to
9479406
Compare
renovate
bot
force-pushed
the
renovate/github.com-spf13-cobra-1.x
branch
from
9479406
to
8d7d485
Compare
renovate
bot
changed the title
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/github.com-spf13-cobra-1.x
branch
from
8d7d485
to
921894b
Compare
renovate
bot
changed the title
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/github.com-spf13-cobra-1.x
branch
from
921894b
to
2c16b80
Compare
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/github.com-spf13-cobra-1.x
branch
from
2c16b80
to
40aaf5b
Compare
renovate
bot
force-pushed
the
renovate/github.com-spf13-cobra-1.x
branch
from
40aaf5b
to
6cfa272
Compare
renovate
bot
changed the title
WalkthroughThe update involves changing the version of the Changes
Sequence Diagram(s)sequenceDiagram
participant App
participant Cobra
App->>Cobra: Initialize Command
Cobra-->>App: Command Ready
App->>Cobra: Execute Command
Cobra-->>App: Return Result
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
renovate
bot
changed the title
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/github.com-spf13-cobra-1.x
branch
from
6cfa272
to
af66bf4
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
go.sumis excluded by!**/*.sum
Files selected for processing (1)
- go.mod (1 hunks)
Additional comments not posted (1)
go.mod (1)
18-18: LGTM! Verify compatibility with the new version.The version update for the
cobrapackage fromv1.1.3tov1.8.1looks good. Ensure that the application is compatible with the new version by running the tests and checking for any deprecated or breaking changes in the release notes.Run the following script to verify the compatibility:
This PR contains the following updates:
v1.1.3->v1.8.1Release Notes
spf13/cobra (github.com/spf13/cobra)
v1.8.1Compare 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.0Compare Source
✨ Features
MarkFlagsOneRequiredAPI 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.SetErrPrefixandErrPrefixAPIs on theCommandstruct 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.0Compare Source
✨ Features
bash,zsh,pwsh, &fish: @h4ck3rk3y #1903🐛 Bug fixes
templateimport variable name: @yashLadha #1879🧪 Testing & CI/CD
🔧 Maintenance
stale.yamlmispellings: @enrichman #1863VitessandArewefastyetto projects using cobra: @frouioui #1932✏️ Documentation
MarkFlagsMutuallyExclusiveexample 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.1Compare Source
Bug fixes 🐛
AddGroupisn't called beforeAddCommand(my-sub-command)is executed. This can happen within more complex cobra file structures that have many differentinits to be executed. Now, the check for groups has been moved toExecuteCand 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.0Compare Source
Summer 2022 Release
Some exciting changes make their way to Cobra! Command completions continue to get better and better (including adding
--helpand--versionautomatic flags to the completions list). Grouping is now possible in your help output as well! And you can now use theOnFinalizemethod to cleanup things when all "work" is done. Checkout the full changelog below:Features 🌠
ValidateRequiredFlagsandValidateFlagGroups: @skeetwu #1760--versionflag to help output: @fnickels #1707--helpand--versionflag in completions: @marckhouzam #1813OnFinalizemethod: @yann-soubeyrand #1788InitDefaultcompletionCmdpublic: @gssbzn #1467Deprecation 👎🏼
ExactValidArgsis deprecated (but not being removed entirely). This is abit nuanced, so checkout #1643 for further information and the updateduser_guide.mdon how this may affect you (and how you can take advantage of the correct behavior in the validators): @umarcor #1643Bug fixes 🐛
activeHelplength check syntax: @scop #1762see_alsofor yaml documentation: @zregvart #1771Dependencies 🗳️
gopkg.in/yaml.v3: @tklauser #1766Testing 🤔
action/setup-gocache: @umarcor #1783workflow_dispatchto CI actions: @umarcor #1387Docs ✏️
SetContextdocumentation: @katexochen #1748go installfor binary: @marckhouzam #1726Misc 💭
exemptyaml 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/cobraGitHub 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.0Compare 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
usernameflag that MUST be partnered with apasswordflag. 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.mdas 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-botsettings - @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.0Compare 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
cobraCLI 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
cobralibrary, 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.0Compare 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.DisableFlagParsingnow triggers custom completions for flag names #1161helpcompletion formatting improvements & fixes #1444helpexample: short desc are now capitalized and removes extra spacing from long description #1455menu-complete,menu-complete-backwardandinsert-completions. These descriptions are now purposefully removed in support of this model. #1509~/.cobra.yaml. Log messageUsing config file: ~/.cobra.yamlnow printed to stderr #1510completioncommand #1541__completecommand 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!
noneNew Features ⭐
MatchAllallows combining several PositionalArgs to work in concert. This now allows for enabling composingPositionalArgs#896Bug Fixes 🐛
initboilerplates #1463 #1552 #1557Testing 👀
args_test#1426golangci-lintgithub action #1477Security 🔏
v1.10.0viper: https://github.com/spf13/cobra/issues/1538. This will be patched in a future releaseDocumentation 📝
projects_using_cobra.mdfile: #1377 #1501 #1454--authorflag is specified #1009shell_completions.mdhas an easier to use snippet for copying and pasting shell completions #1372Other 💭
cpuguy83/go-md2manto v2.0.1 #1460lessertypo from the GPL-2.0 license #880Thank you to all our amazing contributors ⭐🐍🚀
v1.2.1Compare 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
completioncommand for shell completions. If acompletioncommand 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-descriptionsflag for "always on" completion descriptionsmitchellh/go-homedirin favor of core Goos.UserHomeDir()- spf13/cobra@8eaca5fBug Fixes
ShellDirectiveCompletionNoSpaceand file completion all the time - https://github.com/spf13/cobra/pull/1213RegisterFlagCompletionFuncas 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 🐍🚀
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.