Update module github.com/spf13/cobra to v1.8.0

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
github.com/spf13/cobra	v1.4.0 -> v1.8.0

---

Release Notes

spf13/cobra (github.com/spf13/cobra)

v1.8.0

Compare Source

✨ Features

• Support usage as plugin for tools like kubectl by @​nirs in https://github.com/spf13/cobra/pull/2018 - this means that programs that utilize a "plugin-like" structure have much better support and usage (like for completions, command paths, etc.)
• Move documentation sources to site/content by @​umarcor in https://github.com/spf13/cobra/pull/1428
• Add 'one required flag' group by @​marevers in https://github.com/spf13/cobra/pull/1952 - this includes a new 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.
• Customizable error message prefix by @​5ouma in https://github.com/spf13/cobra/pull/2023 - This adds the SetErrPrefix and ErrPrefix APIs on the Command struct to allow for setting a custom prefix for errors
• feat: add getters for flag completions by @​avirtopeanu-ionos in https://github.com/spf13/cobra/pull/1943
• Feature: allow running persistent run hooks of all parents by @​vkhoroz in https://github.com/spf13/cobra/pull/2044
• Improve API to get flag completion function by @​marckhouzam in https://github.com/spf13/cobra/pull/2063

🐛 Bug fixes

• Fix typo in fish completions by @​twpayne in https://github.com/spf13/cobra/pull/1945
• Fix grammar: 'allows to' by @​supertassu in https://github.com/spf13/cobra/pull/1978
• powershell: escape variable with curly brackets by @​Luap99 in https://github.com/spf13/cobra/pull/1960
• Don't complete --help flag when flag parsing disabled by @​marckhouzam in https://github.com/spf13/cobra/pull/2061
• Replace all non-alphanumerics in active help env var program prefix by @​scop in https://github.com/spf13/cobra/pull/1940

🔧 Maintenance

• build(deps): bump golangci/golangci-lint-action from 3.4.0 to 3.5.0 by @​dependabot in https://github.com/spf13/cobra/pull/1971
• build(deps): bump golangci/golangci-lint-action from 3.5.0 to 3.6.0 by @​dependabot in https://github.com/spf13/cobra/pull/1976
• build(deps): bump golangci/golangci-lint-action from 3.6.0 to 3.7.0 by @​dependabot in https://github.com/spf13/cobra/pull/2021
• build(deps): bump actions/setup-go from 3 to 4 by @​dependabot in https://github.com/spf13/cobra/pull/1934
• build(deps): bump github.com/cpuguy83/go-md2man/v2 from 2.0.2 to 2.0.3 by @​dependabot in https://github.com/spf13/cobra/pull/2047
• build(deps): bump actions/checkout from 3 to 4 by @​dependabot in https://github.com/spf13/cobra/pull/2028
• command: temporarily disable G602 due to securego/gosec#1005 by @​umarcor in https://github.com/spf13/cobra/pull/2022

🧪 Testing & CI/CD

• test: make fish_completions_test more robust by @​branchvincent in https://github.com/spf13/cobra/pull/1980
• golangci: enable 'unused' and disable deprecated replaced by it by @​umarcor in https://github.com/spf13/cobra/pull/1983
• cleanup: minor corrections to unit tests by @​JunNishimura in https://github.com/spf13/cobra/pull/2003
• ci: test golang 1.21 by @​nunoadrego in https://github.com/spf13/cobra/pull/2024
• Fix linter errors by @​marckhouzam in https://github.com/spf13/cobra/pull/2052
• Add tests for flag completion registration by @​marckhouzam in https://github.com/spf13/cobra/pull/2053

✏️ Documentation

• doc: fix typo, Deperecated -> Deprecated by @​callthingsoff in https://github.com/spf13/cobra/pull/2000
• Add notes to doc about the execution condition of *PreRun and *PostRun functions by @​haoming29 in https://github.com/spf13/cobra/pull/2041

---

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

• Allow to preserve ordering of completions in bash, zsh, pwsh, & fish: @​h4ck3rk3y #​1903
• Add support for PowerShell 7.2+ in completions: @​oldium #​1916
• Allow sourcing zsh completion script: @​marckhouzam #​1917

🐛 Bug fixes

• Don't remove flag values that match sub-command name: @​brianpursley #​1781
• Fix powershell completions not returning single word: @​totkeks #​1850
• Remove masked template import variable name: @​yashLadha #​1879
• Correctly detect completions with dash in argument: @​oncilla #​1817

🧪 Testing & CI/CD

• Deprecate Go 1.15 in CI: @​umarcor #​1866
• Deprecate Go 1.16 in CI: @​umarcor #​1926
• Add testing for Go 1.20 in CI: @​umarcor #​1925
• Add tests to illustrate unknown flag bug: @​brianpursley #​1854

🔧 Maintenance

• Update main image to better handle dark backgrounds: @​Deleplace and @​marckhouzam #​1883
• Fix stale.yaml mispellings: @​enrichman #​1863
• Remove stale bot from GitHub actions: @​jpmcb #​1908
• Add makefile target for installing dependencies: @​umarcor #​1865
• Add Sia to projects using Cobra: @​mike76-dev #​1844
• Add Vitess and Arewefastyet to projects using cobra: @​frouioui #​1932
• Fixup for Kubescape github org: @​dwertent #​1874
• Fix route for GitHub workflows badge: @​sh-cho #​1884
• Fixup for GoDoc style documentation: @​yashLadha #​1885
• Various bash scripting improvements for completion: @​scop #​1702
• Add Constellation to projects using Cobra: @​datosh #​1829

✏️ Documentation

• Add documentation about disabling completion descriptions: @​Shihta #​1901
• Improve MarkFlagsMutuallyExclusive example in user guide: @​janhn #​1904
• Update shell_completions.md: @​gusega #​1907
• Update copywrite year: @​umarcor #​1927
• Document suggested layout of subcommands: @​lcarva #​1930
• Replace deprecated ExactValidArgs with MatchAll in doc: @​doniacld #​1836

---

This 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 🐛

• Fixes a panic when AddGroup isn't called before AddCommand(my-sub-command) is executed. This can happen within more complex cobra file structures that have many different inits to be executed. Now, the check for groups has been moved to ExecuteC 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 the OnFinalize method to cleanup things when all "work" is done. Checkout the full changelog below:

---

Features 🌠

• Add groups for commands in help: @​aawsome @​marckhouzam #​1003
• Support for case-insensitive command names: @​YuviGold #​1802
• Expose ValidateRequiredFlags and ValidateFlagGroups: @​skeetwu #​1760
• Add --version flag to help output: @​fnickels #​1707
• Add --help and --version flag in completions: @​marckhouzam #​1813
• Add OnFinalize method: @​yann-soubeyrand #​1788
• Allow user to add completion for powershell alias: @​marckhouzam #​1621
• Make InitDefaultcompletionCmd public: @​gssbzn #​1467

Deprecation 👎🏼

• ExactValidArgs is deprecated (but not being removed entirely). This is abit nuanced, so checkout #​1643 for further information and the updated user_guide.md on how this may affect you (and how you can take advantage of the correct behavior in the validators): @​umarcor #​1643

Bug fixes 🐛

• Fix (bash-v2) activeHelp length check syntax: @​scop #​1762
• Fix correct command path in see_also for yaml documentation: @​zregvart #​1771
• Fix showing flags that shadow parent persistent flag in child help messaging: @​brianpursley #​1776

Dependencies 🗳️

• Upgrade to use gopkg.in/yaml.v3: @​tklauser #​1766

Testing 🤔

• Test on Golang 1.19: @​umarcor & @​jpmcb #​1782
• Renamed powershell completion tests: @​marckhouzam #​1803
• Use action/setup-go cache: @​umarcor #​1783
• Add workflow_dispatch to CI actions: @​umarcor #​1387
• Add minimum GitHub token permissions for workflows: @​varunsh-coder #​1792

Docs ✏️

• Fixup spelling for GitHub CLI: @​eltociear #​1744
• Clarify SetContext documentation: @​katexochen #​1748
• Instruct user to go install for binary: @​marckhouzam #​1726
• User guide cleanup: @​marckhouzam #​1656
• Document option to hide the default completion command: @​marckhouzam #​1779

Misc 💭

• Add KubeVirt, CloudQuery, Cilium, Okteto, Zitadel, Allero to projects using cobra: @​maiqueb #​1741, @​yevgenypats #​1742, @​tklauser #​1745, @​jLopezbarb #​1759, @​fforootd #​1772, @​dimabru #​1819
• Use correct stale action exempt yaml keys: @​jpmcb #​1800
• Add missing license headers: @​umarcor #​1809

Note: 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 a password flag. Well, now, you can enforce those as being required together:

rootCmd.Flags().StringVarP(&u, "username", "u", "", "Username (required if password is set)")
rootCmd.Flags().StringVarP(&pw, "password", "p", "", "Password (required if username is set)")
rootCmd.MarkFlagsRequiredTogether("username", "password")

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 👀

• Add backwards-compatibility tests for legacyArgs() by @​marckhouzam in https://github.com/spf13/cobra/pull/1547
• feat: Add how to load completions in your current zsh session by @​ondrejsika in https://github.com/spf13/cobra/pull/1608
• Introduce FixedCompletions by @​emersion in https://github.com/spf13/cobra/pull/1574
• Add shell completion to flag groups by @​marckhouzam in https://github.com/spf13/cobra/pull/1659
• Modify brew prefix path in macOS system by @​imxw in https://github.com/spf13/cobra/pull/1719
• perf(bash-v2): use backslash escape string expansion for tab by @​scop in https://github.com/spf13/cobra/pull/1682
• style(bash-v2): out is not an array variable, do not refer to it as such by @​scop in https://github.com/spf13/cobra/pull/1681
• perf(bash-v2): standard completion optimizations by @​scop in https://github.com/spf13/cobra/pull/1683
• style(bash): out is not an array variable, do not refer to it as such by @​scop in https://github.com/spf13/cobra/pull/1684
• perf(bash-v2): short-circuit descriptionless candidate lists by @​scop in https://github.com/spf13/cobra/pull/1686
• perf(bash-v2): speed up filtering entries with descriptions by @​scop in https://github.com/spf13/cobra/pull/1689
• perf(bash-v2): speed up filtering menu-complete descriptions by @​scop in https://github.com/spf13/cobra/pull/1692
• fix(bash-v2): skip empty completions when filtering descriptions by @​scop in https://github.com/spf13/cobra/pull/1691
• perf(bash-v2): read directly to COMPREPLY on descriptionless short circuit by @​scop in https://github.com/spf13/cobra/pull/1700
• fix: Don't complete _command on zsh by @​twpayne in https://github.com/spf13/cobra/pull/1690
• Improve fish_completions code quality by @​t29kida in https://github.com/spf13/cobra/pull/1515
• Fix handling of descriptions for bash v3 by @​marckhouzam in https://github.com/spf13/cobra/pull/1735
• undefined or nil Args default to ArbitraryArgs by @​umarcor in https://github.com/spf13/cobra/pull/1612
• Add Command.SetContext by @​joshcarp in https://github.com/spf13/cobra/pull/1551
• Wrap printf tab with quotes by @​PapaCharlie in https://github.com/spf13/cobra/pull/1665

Documentation 📝

• Fixed typos in completions docs - @​cuishuang https://github.com/spf13/cobra/pull/1625
• Removed CHANGELOG.md as it isn't updated - @​johnSchnake https://github.com/spf13/cobra/pull/1634
• Minor typo fix in shell_completion.md - @​danieldn https://github.com/spf13/cobra/pull/1678
• Changed branch name in the cobra generator link to 'main' - @​skywalker2909 https://github.com/spf13/cobra/pull/1645
• Fix Command.Context comment by @​katexochen in https://github.com/spf13/cobra/pull/1639
• Change appropriate links from http:// to https:// where applicable - @​deining https://github.com/spf13/cobra/pull/1695

Testing & CI ⚙️

• Test on Golang 1.18 - @​umarcor https://github.com/spf13/cobra/pull/1635
• Use RICHGO_FORCE_COLOR - @​umarcor https://github.com/spf13/cobra/pull/1647
• Adds size labeler GitHub action by @​jpmcb in https://github.com/spf13/cobra/pull/1610
• Update stale-bot settings - @​jpmcb https://github.com/spf13/cobra/pull/1609

Beep boop, bot commits 🤖

• Bumped golangci/golangci-lint-action from 3.1.0 to 3.2.0 - @​dependabot https://github.com/spf13/cobra/pull/1697
• Bump codelytv/pr-size-labeler from 1.8.0 to 1.8.1 - @​dependabot https://github.com/spf13/cobra/pull/1661
• Bump actions/stale from 1 to 5 by @​dependabot in https://github.com/spf13/cobra/pull/1618
• Bump actions/cache from 2 to 3 by @​dependabot in https://github.com/spf13/cobra/pull/1640
• Bump actions/labeler from 3 to 4 by @​dependabot in https://github.com/spf13/cobra/pull/1620
• Bump golangci/golangci-lint-action from 2 to 3.1.0 by @​dependabot in https://github.com/spf13/cobra/pull/1615
• Bump actions/checkout from 2 to 3 by @​dependabot in https://github.com/spf13/cobra/pull/1619
• Bump github.com/cpuguy83/go-md2man/v2 from 2.0.1 to 2.0.2 by @​dependabot in https://github.com/spf13/cobra/pull/1688
• Bump actions/setup-go from 2 to 3 by @​dependabot in https://github.com/spf13/cobra/pull/1660

Misc 💭

• Use errors.Is() to check for errors - @​Luap99 https://github.com/spf13/cobra/pull/1730
• Prefer ReplaceAll instead of Replace(..., -1) by @​WhyNotHugo in https://github.com/spf13/cobra/pull/1530
• Add Kubescape to projects - @​avinashupadhya99 https://github.com/spf13/cobra/pull/1642
• Add Pulumi as a project using cobra by @​iwahbe in https://github.com/spf13/cobra/pull/1720
• Add Polygon Edge as a project using Cobra by @​zivkovicmilos in https://github.com/spf13/cobra/pull/1672

Shoutout 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

---

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.

---

• If you want to rebase/retry this PR, check this box

---

This PR has been generated by Mend Renovate. View repository job log here.