volker.raschek/docker-hub-description-updater
1
0
Fork 0
Code Issues Pull Requests 2 Projects Releases Wiki Activity

chore(deps): update module github.com/spf13/cobra to v1 #3

Open
CSRBot wants to merge 1 commits from renovate/github.com-spf13-cobra-1.x into master
pull from: renovate/github.com-spf13-cobra-1.x
merge into: volker.raschek:master
Conversation 1 Commits 1 Files Changed 2 +16 -3
CSRBot commented 2025-03-31 18:09:54 +02:00
Collaborator
Copy Link

This PR contains the following updates:

Package Type Update Change
github.com/spf13/cobra require major v0.0.3 -> v1.9.1

Release Notes

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

v1.9.1

Compare Source

🐛 Fixes

Full Changelog: https://github.com/spf13/cobra/compare/v1.9.0...v1.9.1

v1.9.0

Compare Source

✨ Features

🐛 Fixes

🤖 Completions

🧪 Testing

✍🏼 Documentation

🔧 Dependency upgrades

Thank you to all of our amazing contributors and all the great work that's been going into the completions feature!!

👋🏼 New Contributors

Full Changelog: https://github.com/spf13/cobra/compare/v1.8.1...v1.9.0

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: https://github.com/spf13/cobra/compare/v1.8.0...v1.8.1

v1.8.0

Compare Source

✨ Features

🐛 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: https://github.com/spf13/cobra/compare/v1.7.0...v1.8.0

v1.7.0

Compare Source

✨ Features
🐛 Bug fixes
🧪 Testing & CI/CD
🔧 Maintenance
✏️ Documentation

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: https://github.com/spf13/cobra/compare/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 🌠
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 🐛
Dependencies 🗳️
Testing 🤔
Docs ✏️
Misc 💭

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: https://github.com/spf13/cobra/compare/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 👀

Documentation 📝

Testing & CI ⚙️

Beep boop, bot commits 🤖

Misc 💭

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: https://github.com/spf13/cobra/compare/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 to spf13/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

"github.com/spf13/cobra/cobra"

with

"github.com/spf13/cobra-cli"

And in your go.mod, you'll want to also include this dependency:

github.com/spf13/cobra-cli v1.3.0

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 📝

Other 💭

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 #​1161
  • Fixed unbound variables in bash completions causing edge case errors #​1321
  • help completion formatting improvements & fixes #​1444
  • All completions now follow the help example: short desc are now capitalized and removes extra spacing from long description #​1455
  • Typo fixes in bash & zsh completions #​1459
  • Fixed mixed tab/spaces indentation in completion scripts. Now just 4 spaces #​1473
  • Support for different bash completion options. Bash completions v2 supports descriptions and requires descriptions to be removed for menu-complete, menu-complete-backward and insert-completions. These descriptions are now purposefully removed in support of this model. #​1509
  • Fix for invalid shell completions when using ~/.cobra.yaml. Log message Using config file: ~/.cobra.yaml now printed to stderr #​1510
  • Removes unnecessary trailing spaces from completion command descriptions #​1520
  • Option to hide default completion command #​1541
  • Remove __complete command for programs without subcommands #​1563

Generator changes ⚙️

Thanks to @​spf13 for providing a number of changes to the Cobra generator tool, streamlining it for new users!

  • The Cobra generator now won't automatically include Viper and cleans up a number of unused imports when not using Viper.
  • The Cobra generator's default license is now none
  • The Cobra generator now works with Go modules
  • Documentation to reflect these changes

New Features ⭐

  • License can be specified by their SPDX identifiers #​1159
  • MatchAll allows combining several PositionalArgs to work in concert. This now allows for enabling composing PositionalArgs #​896

Bug Fixes 🐛

Testing 👀

  • Now testing golang 1.16.x and 1.17.x in CI #​1425
  • Fix for running diff test to ignore CR for windows #​949
  • Added helper functions and reduced code reproduction in args_test #​1426
  • Now using official golangci-lint github action #​1477

Security 🔏

Documentation 📝

  • Multiple projects added to the projects_using_cobra.md file: #​1377 #​1501 #​1454
  • Removed ToC from main readme file as it is now automagically displayed by GitHub #​1429
  • Documentation correct for when the --author flag is specified #​1009
  • shell_completions.md has an easier to use snippet for copying and pasting shell completions #​1372

Other 💭

  • Bump version of cpuguy83/go-md2man to v2.0.1 #​1460
  • Removed lesser typo from the GPL-2.0 license #​880
  • Fixed spelling errors #​1514

Thank you to all our amazing contributors ⭐🐍🚀

v1.2.1

Compare Source

Bug fixes

v1.2.0: - The completions release

Compare 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

  • Automatically adds a 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 but will be deprecated in a later 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
  • Removed dependency onmitchellh/go-homedir in favor of core Go os.UserHomeDir() - 8eaca5f0f4

Bug Fixes

Testing

  • Deprecated Travis CI. Now fully using Github Actions - d0f318d45b
  • 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

Other

Thank you to all our amazing contributors 🐍🚀

v1.1.3

Compare Source

  • Fix: release-branch.cobra1.1 only: Revert "Deprecate Go < 1.14" to maintain backward compatibility

v1.1.2

Compare Source

Notable Changes

v1.1.1

Compare Source

v1.1.0

Compare Source

Notable Changes

  • Extend Go completions and revamp zsh comp (#​1070)
  • Fix man page doc generation - no auto generated tag when cmd.DisableAutoGenTag = true (#​1104)
  • Add completion for help command (#​1136)
  • Complete subcommands when TraverseChildren is set (#​1171)
  • Fix stderr printing functions (#​894)
  • fix: fish output redirection (#​1247)

v1.0.0

Compare Source

v1.0.0

Announcing v1.0.0 of Cobra. 🎉

Notable Changes

v0.0.7

Compare Source

Bug fix to restore previous exit behavior when a command is not runnable.

Issue Ref: #​1056
Bug Introduced: #​922
Affected Releases: 0.0.6

v0.0.6

Compare Source

v0.0.5

Compare Source

v0.0.4: 0.0.4

Compare Source

As requested in #​259 and #​857.

Changes:

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 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.

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

This PR has been generated by Renovate Bot.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/spf13/cobra](https://github.com/spf13/cobra) | require | major | `v0.0.3` -> `v1.9.1` | --- ### Release Notes <details> <summary>spf13/cobra (github.com/spf13/cobra)</summary> ### [`v1.9.1`](https://github.com/spf13/cobra/releases/tag/v1.9.1) [Compare Source](https://github.com/spf13/cobra/compare/v1.9.0...v1.9.1) ##### 🐛 Fixes - Fix CompletionFunc implementation by [@&#8203;ccoVeille](https://github.com/ccoVeille) in https://github.com/spf13/cobra/pull/2234 - Revert "Make detection for test-binary more universal ([#&#8203;2173](https://github.com/spf13/cobra/issues/2173))" by [@&#8203;marckhouzam](https://github.com/marckhouzam) in https://github.com/spf13/cobra/pull/2235 **Full Changelog**: https://github.com/spf13/cobra/compare/v1.9.0...v1.9.1 ### [`v1.9.0`](https://github.com/spf13/cobra/releases/tag/v1.9.0) [Compare Source](https://github.com/spf13/cobra/compare/v1.8.1...v1.9.0) #### ✨ Features - Allow linker to perform deadcode elimination for program using Cobra by [@&#8203;aarzilli](https://github.com/aarzilli) in https://github.com/spf13/cobra/pull/1956 - Add default completion command even if there are no other sub-commands by [@&#8203;marckhouzam](https://github.com/marckhouzam) in https://github.com/spf13/cobra/pull/1559 - Add CompletionWithDesc helper by [@&#8203;ccoVeille](https://github.com/ccoVeille) in https://github.com/spf13/cobra/pull/2231 #### 🐛 Fixes - Fix deprecation comment for Command.SetOutput by [@&#8203;thaJeztah](https://github.com/thaJeztah) in https://github.com/spf13/cobra/pull/2172 - Replace deprecated ioutil usage by [@&#8203;nirs](https://github.com/nirs) in https://github.com/spf13/cobra/pull/2181 - Fix --version help and output for plugins by [@&#8203;nirs](https://github.com/nirs) in https://github.com/spf13/cobra/pull/2180 - Allow to reset the templates to the default by [@&#8203;marckhouzam](https://github.com/marckhouzam) in https://github.com/spf13/cobra/pull/2229 #### 🤖 Completions - Make Powershell completion work in constrained mode by [@&#8203;lstemplinger](https://github.com/lstemplinger) in https://github.com/spf13/cobra/pull/2196 - Improve detection for flags that accept multiple values by [@&#8203;thaJeztah](https://github.com/thaJeztah) in https://github.com/spf13/cobra/pull/2210 - add CompletionFunc type to help with completions by [@&#8203;ccoVeille](https://github.com/ccoVeille) in https://github.com/spf13/cobra/pull/2220 - Add similar whitespace escape logic to bash v2 completions than in other completions by [@&#8203;kangasta](https://github.com/kangasta) in https://github.com/spf13/cobra/pull/1743 - Print ActiveHelp for bash along other completions by [@&#8203;marckhouzam](https://github.com/marckhouzam) in https://github.com/spf13/cobra/pull/2076 - fix(completions): Complete map flags multiple times by [@&#8203;gabe565](https://github.com/gabe565) in https://github.com/spf13/cobra/pull/2174 - fix(bash): nounset unbound file filter variable on empty extension by [@&#8203;scop](https://github.com/scop) in https://github.com/spf13/cobra/pull/2228 #### 🧪 Testing - Test also with go 1.23 by [@&#8203;nirs](https://github.com/nirs) in https://github.com/spf13/cobra/pull/2182 - Make detection for test-binary more universal by [@&#8203;thaJeztah](https://github.com/thaJeztah) in https://github.com/spf13/cobra/pull/2173 #### ✍🏼 Documentation - docs: update README.md by [@&#8203;eltociear](https://github.com/eltociear) in https://github.com/spf13/cobra/pull/2197 - Improve site formatting by [@&#8203;nirs](https://github.com/nirs) in https://github.com/spf13/cobra/pull/2183 - doc: add Conduit by [@&#8203;raulb](https://github.com/raulb) in https://github.com/spf13/cobra/pull/2230 - doc: azion project added to the list of CLIs that use cobra by [@&#8203;maxwelbm](https://github.com/maxwelbm) in https://github.com/spf13/cobra/pull/2198 - Fix broken links in active_help.md by [@&#8203;vuil](https://github.com/vuil) in https://github.com/spf13/cobra/pull/2202 - chore: fix function name in comment by [@&#8203;zhuhaicity](https://github.com/zhuhaicity) in https://github.com/spf13/cobra/pull/2216 #### 🔧 Dependency upgrades - build(deps): bump github.com/cpuguy83/go-md2man/v2 from 2.0.5 to 2.0.6 by [@&#8203;thaJeztah](https://github.com/thaJeztah) in https://github.com/spf13/cobra/pull/2206 - Update to latest go-md2man by [@&#8203;mikelolasagasti](https://github.com/mikelolasagasti) in https://github.com/spf13/cobra/pull/2201 - Upgrade `pflag` dependencies for v1.9.0 by [@&#8203;jpmcb](https://github.com/jpmcb) in https://github.com/spf13/cobra/pull/2233 *** Thank you to all of our amazing contributors and all the great work that's been going into the completions feature!! ##### 👋🏼 New Contributors - [@&#8203;gabe565](https://github.com/gabe565) made their first contribution in https://github.com/spf13/cobra/pull/2174 - [@&#8203;maxwelbm](https://github.com/maxwelbm) made their first contribution in https://github.com/spf13/cobra/pull/2198 - [@&#8203;lstemplinger](https://github.com/lstemplinger) made their first contribution in https://github.com/spf13/cobra/pull/2196 - [@&#8203;vuil](https://github.com/vuil) made their first contribution in https://github.com/spf13/cobra/pull/2202 - [@&#8203;mikelolasagasti](https://github.com/mikelolasagasti) made their first contribution in https://github.com/spf13/cobra/pull/2201 - [@&#8203;zhuhaicity](https://github.com/zhuhaicity) made their first contribution in https://github.com/spf13/cobra/pull/2216 - [@&#8203;ccoVeille](https://github.com/ccoVeille) made their first contribution in https://github.com/spf13/cobra/pull/2220 - [@&#8203;kangasta](https://github.com/kangasta) made their first contribution in https://github.com/spf13/cobra/pull/1743 - [@&#8203;aarzilli](https://github.com/aarzilli) made their first contribution in https://github.com/spf13/cobra/pull/1956 **Full Changelog**: https://github.com/spf13/cobra/compare/v1.8.1...v1.9.0 ### [`v1.8.1`](https://github.com/spf13/cobra/releases/tag/v1.8.1) [Compare Source](https://github.com/spf13/cobra/compare/v1.8.0...v1.8.1) #### ✨ Features - Add env variable to suppress completion descriptions on create by [@&#8203;scop](https://github.com/scop) in https://github.com/spf13/cobra/pull/1938 #### 🐛 Bug fixes - Micro-optimizations by [@&#8203;scop](https://github.com/scop) in https://github.com/spf13/cobra/pull/1957 #### 🔧 Maintenance - build(deps): bump github.com/cpuguy83/go-md2man/v2 from 2.0.3 to 2.0.4 by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/2127 - Consistent annotation names by [@&#8203;nirs](https://github.com/nirs) in https://github.com/spf13/cobra/pull/2140 - Remove fully inactivated linters by [@&#8203;nirs](https://github.com/nirs) in https://github.com/spf13/cobra/pull/2148 - Address golangci-lint deprecation warnings, enable some more linters by [@&#8203;scop](https://github.com/scop) in https://github.com/spf13/cobra/pull/2152 #### 🧪 Testing & CI/CD - Add test for func in cobra.go by [@&#8203;korovindenis](https://github.com/korovindenis) in https://github.com/spf13/cobra/pull/2094 - ci: test golang 1.22 by [@&#8203;cyrilico](https://github.com/cyrilico) in https://github.com/spf13/cobra/pull/2113 - Optimized and added more linting by [@&#8203;scop](https://github.com/scop) in https://github.com/spf13/cobra/pull/2099 - build(deps): bump actions/setup-go from 4 to 5 by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/2087 - build(deps): bump actions/labeler from 4 to 5 by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/2086 - build(deps): bump golangci/golangci-lint-action from 3.7.0 to 4.0.0 by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/2108 - build(deps): bump actions/cache from 3 to 4 by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/2102 #### ✏️ Documentation - Fixes and docs for usage as plugin by [@&#8203;nirs](https://github.com/nirs) in https://github.com/spf13/cobra/pull/2070 - flags: clarify documentation that LocalFlags related function do not modify the state by [@&#8203;niamster](https://github.com/niamster) in https://github.com/spf13/cobra/pull/2064 - chore: remove repetitive words by [@&#8203;racerole](https://github.com/racerole) in https://github.com/spf13/cobra/pull/2122 - Add LXC to the list of projects using Cobra [@&#8203;VaradBelwalkar](https://github.com/VaradBelwalkar) in https://github.com/spf13/cobra/pull/2071 - Update projects_using_cobra.md by [@&#8203;marcuskohlberg](https://github.com/marcuskohlberg) in https://github.com/spf13/cobra/pull/2089 - \[chore]: update projects using cobra by [@&#8203;cmwylie19](https://github.com/cmwylie19) in https://github.com/spf13/cobra/pull/2093 - Add Taikun CLI to list of projects by [@&#8203;Smidra](https://github.com/Smidra) in https://github.com/spf13/cobra/pull/2098 - Add Incus to the list of projects using Cobra by [@&#8203;montag451](https://github.com/montag451) in https://github.com/spf13/cobra/pull/2118 #### New Contributors - [@&#8203;VaradBelwalkar](https://github.com/VaradBelwalkar) made their first contribution in https://github.com/spf13/cobra/pull/2071 - [@&#8203;marcuskohlberg](https://github.com/marcuskohlberg) made their first contribution in https://github.com/spf13/cobra/pull/2089 - [@&#8203;cmwylie19](https://github.com/cmwylie19) made their first contribution in https://github.com/spf13/cobra/pull/2093 - [@&#8203;korovindenis](https://github.com/korovindenis) made their first contribution in https://github.com/spf13/cobra/pull/2094 - [@&#8203;niamster](https://github.com/niamster) made their first contribution in https://github.com/spf13/cobra/pull/2064 - [@&#8203;Smidra](https://github.com/Smidra) made their first contribution in https://github.com/spf13/cobra/pull/2098 - [@&#8203;montag451](https://github.com/montag451) made their first contribution in https://github.com/spf13/cobra/pull/2118 - [@&#8203;cyrilico](https://github.com/cyrilico) made their first contribution in https://github.com/spf13/cobra/pull/2113 - [@&#8203;racerole](https://github.com/racerole) made their first contribution in https://github.com/spf13/cobra/pull/2122 - [@&#8203;pedromotita](https://github.com/pedromotita) made their first contribution in https://github.com/spf13/cobra/pull/2120 - [@&#8203;cubxxw](https://github.com/cubxxw) made their first contribution in https://github.com/spf13/cobra/pull/2128 *** 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**: https://github.com/spf13/cobra/compare/v1.8.0...v1.8.1 ### [`v1.8.0`](https://github.com/spf13/cobra/releases/tag/v1.8.0) [Compare Source](https://github.com/spf13/cobra/compare/v1.7.0...v1.8.0) #### ✨ Features - Support usage as plugin for tools like kubectl by [@&#8203;nirs](https://github.com/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 [@&#8203;umarcor](https://github.com/umarcor) in https://github.com/spf13/cobra/pull/1428 - Add 'one required flag' group by [@&#8203;marevers](https://github.com/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 [@&#8203;5ouma](https://github.com/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 [@&#8203;avirtopeanu-ionos](https://github.com/avirtopeanu-ionos) in https://github.com/spf13/cobra/pull/1943 - Feature: allow running persistent run hooks of all parents by [@&#8203;vkhoroz](https://github.com/vkhoroz) in https://github.com/spf13/cobra/pull/2044 - Improve API to get flag completion function by [@&#8203;marckhouzam](https://github.com/marckhouzam) in https://github.com/spf13/cobra/pull/2063 #### 🐛 Bug fixes - Fix typo in fish completions by [@&#8203;twpayne](https://github.com/twpayne) in https://github.com/spf13/cobra/pull/1945 - Fix grammar: 'allows to' by [@&#8203;supertassu](https://github.com/supertassu) in https://github.com/spf13/cobra/pull/1978 - powershell: escape variable with curly brackets by [@&#8203;Luap99](https://github.com/Luap99) in https://github.com/spf13/cobra/pull/1960 - Don't complete --help flag when flag parsing disabled by [@&#8203;marckhouzam](https://github.com/marckhouzam) in https://github.com/spf13/cobra/pull/2061 - Replace all non-alphanumerics in active help env var program prefix by [@&#8203;scop](https://github.com/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 [@&#8203;dependabot](https://github.com/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 [@&#8203;dependabot](https://github.com/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 [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/2021 - build(deps): bump actions/setup-go from 3 to 4 by [@&#8203;dependabot](https://github.com/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 [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/2047 - build(deps): bump actions/checkout from 3 to 4 by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/2028 - command: temporarily disable G602 due to [securego/gosec#1005](https://github.com/securego/gosec/issues/1005) by [@&#8203;umarcor](https://github.com/umarcor) in https://github.com/spf13/cobra/pull/2022 #### 🧪 Testing & CI/CD - test: make fish_completions_test more robust by [@&#8203;branchvincent](https://github.com/branchvincent) in https://github.com/spf13/cobra/pull/1980 - golangci: enable 'unused' and disable deprecated replaced by it by [@&#8203;umarcor](https://github.com/umarcor) in https://github.com/spf13/cobra/pull/1983 - cleanup: minor corrections to unit tests by [@&#8203;JunNishimura](https://github.com/JunNishimura) in https://github.com/spf13/cobra/pull/2003 - ci: test golang 1.21 by [@&#8203;nunoadrego](https://github.com/nunoadrego) in https://github.com/spf13/cobra/pull/2024 - Fix linter errors by [@&#8203;marckhouzam](https://github.com/marckhouzam) in https://github.com/spf13/cobra/pull/2052 - Add tests for flag completion registration by [@&#8203;marckhouzam](https://github.com/marckhouzam) in https://github.com/spf13/cobra/pull/2053 #### ✏️ Documentation - doc: fix typo, Deperecated -> Deprecated by [@&#8203;callthingsoff](https://github.com/callthingsoff) in https://github.com/spf13/cobra/pull/2000 - Add notes to doc about the execution condition of \*PreRun and \*PostRun functions by [@&#8203;haoming29](https://github.com/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**: https://github.com/spf13/cobra/compare/v1.7.0...v1.8.0 ### [`v1.7.0`](https://github.com/spf13/cobra/releases/tag/v1.7.0) [Compare Source](https://github.com/spf13/cobra/compare/v1.6.1...v1.7.0) ##### ✨ Features - Allow to preserve ordering of completions in `bash`, `zsh`, `pwsh`, & `fish`: [@&#8203;h4ck3rk3y](https://github.com/h4ck3rk3y) [#&#8203;1903](https://github.com/spf13/cobra/issues/1903) - Add support for PowerShell 7.2+ in completions: [@&#8203;oldium](https://github.com/oldium) [#&#8203;1916](https://github.com/spf13/cobra/issues/1916) - Allow sourcing zsh completion script: [@&#8203;marckhouzam](https://github.com/marckhouzam) [#&#8203;1917](https://github.com/spf13/cobra/issues/1917) ##### 🐛 Bug fixes - Don't remove flag values that match sub-command name: [@&#8203;brianpursley](https://github.com/brianpursley) [#&#8203;1781](https://github.com/spf13/cobra/issues/1781) - Fix powershell completions not returning single word: [@&#8203;totkeks](https://github.com/totkeks) [#&#8203;1850](https://github.com/spf13/cobra/issues/1850) - Remove masked `template` import variable name: [@&#8203;yashLadha](https://github.com/yashLadha) [#&#8203;1879](https://github.com/spf13/cobra/issues/1879) - Correctly detect completions with dash in argument: [@&#8203;oncilla](https://github.com/oncilla) [#&#8203;1817](https://github.com/spf13/cobra/issues/1817) ##### 🧪 Testing & CI/CD - Deprecate Go 1.15 in CI: [@&#8203;umarcor](https://github.com/umarcor) [#&#8203;1866](https://github.com/spf13/cobra/issues/1866) - Deprecate Go 1.16 in CI: [@&#8203;umarcor](https://github.com/umarcor) [#&#8203;1926](https://github.com/spf13/cobra/issues/1926) - Add testing for Go 1.20 in CI: [@&#8203;umarcor](https://github.com/umarcor) [#&#8203;1925](https://github.com/spf13/cobra/issues/1925) - Add tests to illustrate unknown flag bug: [@&#8203;brianpursley](https://github.com/brianpursley) [#&#8203;1854](https://github.com/spf13/cobra/issues/1854) ##### 🔧 Maintenance - Update main image to better handle dark backgrounds: [@&#8203;Deleplace](https://github.com/Deleplace) and [@&#8203;marckhouzam](https://github.com/marckhouzam) [#&#8203;1883](https://github.com/spf13/cobra/issues/1883) - Fix `stale.yaml` mispellings: [@&#8203;enrichman](https://github.com/enrichman) [#&#8203;1863](https://github.com/spf13/cobra/issues/1863) - Remove stale bot from GitHub actions: [@&#8203;jpmcb](https://github.com/jpmcb) [#&#8203;1908](https://github.com/spf13/cobra/issues/1908) - Add makefile target for installing dependencies: [@&#8203;umarcor](https://github.com/umarcor) [#&#8203;1865](https://github.com/spf13/cobra/issues/1865) - Add Sia to projects using Cobra: [@&#8203;mike76-dev](https://github.com/mike76-dev) [#&#8203;1844](https://github.com/spf13/cobra/issues/1844) - Add `Vitess` and `Arewefastyet` to projects using cobra: [@&#8203;frouioui](https://github.com/frouioui) [#&#8203;1932](https://github.com/spf13/cobra/issues/1932) - Fixup for Kubescape github org: [@&#8203;dwertent](https://github.com/dwertent) [#&#8203;1874](https://github.com/spf13/cobra/issues/1874) - Fix route for GitHub workflows badge: [@&#8203;sh-cho](https://github.com/sh-cho) [#&#8203;1884](https://github.com/spf13/cobra/issues/1884) - Fixup for GoDoc style documentation: [@&#8203;yashLadha](https://github.com/yashLadha) [#&#8203;1885](https://github.com/spf13/cobra/issues/1885) - Various bash scripting improvements for completion: [@&#8203;scop](https://github.com/scop) [#&#8203;1702](https://github.com/spf13/cobra/issues/1702) - Add Constellation to projects using Cobra: [@&#8203;datosh](https://github.com/datosh) [#&#8203;1829](https://github.com/spf13/cobra/issues/1829) ##### ✏️ Documentation - Add documentation about disabling completion descriptions: [@&#8203;Shihta](https://github.com/Shihta) [#&#8203;1901](https://github.com/spf13/cobra/issues/1901) - Improve `MarkFlagsMutuallyExclusive` example in user guide: [@&#8203;janhn](https://github.com/janhn) [#&#8203;1904](https://github.com/spf13/cobra/issues/1904) - Update `shell_completions.md`: [@&#8203;gusega](https://github.com/gusega) [#&#8203;1907](https://github.com/spf13/cobra/issues/1907) - Update copywrite year: [@&#8203;umarcor](https://github.com/umarcor) [#&#8203;1927](https://github.com/spf13/cobra/issues/1927) - Document suggested layout of subcommands: [@&#8203;lcarva](https://github.com/lcarva) [#&#8203;1930](https://github.com/spf13/cobra/issues/1930) - Replace deprecated ExactValidArgs with MatchAll in doc: [@&#8203;doniacld](https://github.com/doniacld) [#&#8203;1836](https://github.com/spf13/cobra/issues/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: https://github.com/spf13/cobra/compare/v1.6.1...v1.7.0 ### [`v1.6.1`](https://github.com/spf13/cobra/releases/tag/v1.6.1) [Compare Source](https://github.com/spf13/cobra/compare/v1.6.0...v1.6.1) ##### 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 `init`s to be executed. Now, the check for groups has been moved to `ExecuteC` and provides more flexibility when working with grouped commands - [@&#8203;marckhouzam](https://github.com/marckhouzam) (and shout out to [@&#8203;aawsome](https://github.com/aawsome), [@&#8203;andig](https://github.com/andig) and [@&#8203;KINGSABRI](https://github.com/KINGSABRI) for a deep investigation into this! 👏🏼) ### [`v1.6.0`](https://github.com/spf13/cobra/releases/tag/v1.6.0) [Compare Source](https://github.com/spf13/cobra/compare/v1.5.0...v1.6.0) ##### 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: [@&#8203;aawsome](https://github.com/aawsome) [@&#8203;marckhouzam](https://github.com/marckhouzam) [#&#8203;1003](https://github.com/spf13/cobra/issues/1003) - Support for case-insensitive command names: [@&#8203;YuviGold](https://github.com/YuviGold) [#&#8203;1802](https://github.com/spf13/cobra/issues/1802) - Expose `ValidateRequiredFlags` and `ValidateFlagGroups`: [@&#8203;skeetwu](https://github.com/skeetwu) [#&#8203;1760](https://github.com/spf13/cobra/issues/1760) - Add `--version` flag to help output: [@&#8203;fnickels](https://github.com/fnickels) [#&#8203;1707](https://github.com/spf13/cobra/issues/1707) - Add `--help` and `--version` flag in completions: [@&#8203;marckhouzam](https://github.com/marckhouzam) [#&#8203;1813](https://github.com/spf13/cobra/issues/1813) - Add `OnFinalize` method: [@&#8203;yann-soubeyrand](https://github.com/yann-soubeyrand) [#&#8203;1788](https://github.com/spf13/cobra/issues/1788) - Allow user to add completion for powershell alias: [@&#8203;marckhouzam](https://github.com/marckhouzam) [#&#8203;1621](https://github.com/spf13/cobra/issues/1621) - Make `InitDefaultcompletionCmd` public: [@&#8203;gssbzn](https://github.com/gssbzn) [#&#8203;1467](https://github.com/spf13/cobra/issues/1467) ##### Deprecation 👎🏼 - `ExactValidArgs` is deprecated (but not being removed entirely). This is abit nuanced, so checkout [#&#8203;1643](https://github.com/spf13/cobra/issues/1643) for further information and the [updated `user_guide.md`](https://github.com/spf13/cobra/blob/main/user_guide.md) on how this may affect you (and how you can take advantage of the *correct* behavior in the validators): [@&#8203;umarcor](https://github.com/umarcor) [#&#8203;1643](https://github.com/spf13/cobra/issues/1643) ##### Bug fixes 🐛 - Fix (bash-v2) `activeHelp` length check syntax: [@&#8203;scop](https://github.com/scop) [#&#8203;1762](https://github.com/spf13/cobra/issues/1762) - Fix correct command path in `see_also` for yaml documentation: [@&#8203;zregvart](https://github.com/zregvart) [#&#8203;1771](https://github.com/spf13/cobra/issues/1771) - Fix showing flags that shadow parent persistent flag in child help messaging: [@&#8203;brianpursley](https://github.com/brianpursley) [#&#8203;1776](https://github.com/spf13/cobra/issues/1776) ##### Dependencies 🗳️ - Upgrade to use `gopkg.in/yaml.v3`: [@&#8203;tklauser](https://github.com/tklauser) [#&#8203;1766](https://github.com/spf13/cobra/issues/1766) ##### Testing 🤔 - Test on Golang 1.19: [@&#8203;umarcor](https://github.com/umarcor) & [@&#8203;jpmcb](https://github.com/jpmcb) [#&#8203;1782](https://github.com/spf13/cobra/issues/1782) - Renamed powershell completion tests: [@&#8203;marckhouzam](https://github.com/marckhouzam) [#&#8203;1803](https://github.com/spf13/cobra/issues/1803) - Use `action/setup-go` cache: [@&#8203;umarcor](https://github.com/umarcor) [#&#8203;1783](https://github.com/spf13/cobra/issues/1783) - Add `workflow_dispatch` to CI actions: [@&#8203;umarcor](https://github.com/umarcor) [#&#8203;1387](https://github.com/spf13/cobra/issues/1387) - Add minimum GitHub token permissions for workflows: [@&#8203;varunsh-coder](https://github.com/varunsh-coder) [#&#8203;1792](https://github.com/spf13/cobra/issues/1792) ##### Docs ✏️ - Fixup spelling for GitHub CLI: [@&#8203;eltociear](https://github.com/eltociear) [#&#8203;1744](https://github.com/spf13/cobra/issues/1744) - Clarify `SetContext` documentation: [@&#8203;katexochen](https://github.com/katexochen) [#&#8203;1748](https://github.com/spf13/cobra/issues/1748) - Instruct user to `go install` for binary: [@&#8203;marckhouzam](https://github.com/marckhouzam) [#&#8203;1726](https://github.com/spf13/cobra/issues/1726) - User guide cleanup: [@&#8203;marckhouzam](https://github.com/marckhouzam) [#&#8203;1656](https://github.com/spf13/cobra/issues/1656) - Document option to hide the default completion command: [@&#8203;marckhouzam](https://github.com/marckhouzam) [#&#8203;1779](https://github.com/spf13/cobra/issues/1779) ##### Misc 💭 - Add KubeVirt, CloudQuery, Cilium, Okteto, Zitadel, Allero to projects using cobra: [@&#8203;maiqueb](https://github.com/maiqueb) [#&#8203;1741](https://github.com/spf13/cobra/issues/1741), [@&#8203;yevgenypats](https://github.com/yevgenypats) [#&#8203;1742](https://github.com/spf13/cobra/issues/1742), [@&#8203;tklauser](https://github.com/tklauser) [#&#8203;1745](https://github.com/spf13/cobra/issues/1745), [@&#8203;jLopezbarb](https://github.com/jLopezbarb) [#&#8203;1759](https://github.com/spf13/cobra/issues/1759), [@&#8203;fforootd](https://github.com/fforootd) [#&#8203;1772](https://github.com/spf13/cobra/issues/1772), [@&#8203;dimabru](https://github.com/dimabru) [#&#8203;1819](https://github.com/spf13/cobra/issues/1819) - Use correct stale action `exempt` yaml keys: [@&#8203;jpmcb](https://github.com/jpmcb) [#&#8203;1800](https://github.com/spf13/cobra/issues/1800) - Add missing license headers: [@&#8203;umarcor](https://github.com/umarcor) [#&#8203;1809](https://github.com/spf13/cobra/issues/1809) *Note:* Per [#&#8203;1804](https://github.com/spf13/cobra/issues/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**: https://github.com/spf13/cobra/compare/v1.5.0...v1.6.0 ### [`v1.5.0`](https://github.com/spf13/cobra/releases/tag/v1.5.0) [Compare Source](https://github.com/spf13/cobra/compare/v1.4.0...v1.5.0) #### 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 [@&#8203;marckhouzam](https://github.com/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 [@&#8203;johnSchnake](https://github.com/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: ```go 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](https://github.com/spf13/cobra/blob/master/user_guide.md) for further info! #### Completions 👀 - Add backwards-compatibility tests for legacyArgs() by [@&#8203;marckhouzam](https://github.com/marckhouzam) in https://github.com/spf13/cobra/pull/1547 - feat: Add how to load completions in your current zsh session by [@&#8203;ondrejsika](https://github.com/ondrejsika) in https://github.com/spf13/cobra/pull/1608 - Introduce FixedCompletions by [@&#8203;emersion](https://github.com/emersion) in https://github.com/spf13/cobra/pull/1574 - Add shell completion to flag groups by [@&#8203;marckhouzam](https://github.com/marckhouzam) in https://github.com/spf13/cobra/pull/1659 - Modify brew prefix path in macOS system by [@&#8203;imxw](https://github.com/imxw) in https://github.com/spf13/cobra/pull/1719 - perf(bash-v2): use backslash escape string expansion for tab by [@&#8203;scop](https://github.com/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 [@&#8203;scop](https://github.com/scop) in https://github.com/spf13/cobra/pull/1681 - perf(bash-v2): standard completion optimizations by [@&#8203;scop](https://github.com/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 [@&#8203;scop](https://github.com/scop) in https://github.com/spf13/cobra/pull/1684 - perf(bash-v2): short-circuit descriptionless candidate lists by [@&#8203;scop](https://github.com/scop) in https://github.com/spf13/cobra/pull/1686 - perf(bash-v2): speed up filtering entries with descriptions by [@&#8203;scop](https://github.com/scop) in https://github.com/spf13/cobra/pull/1689 - perf(bash-v2): speed up filtering menu-complete descriptions by [@&#8203;scop](https://github.com/scop) in https://github.com/spf13/cobra/pull/1692 - fix(bash-v2): skip empty completions when filtering descriptions by [@&#8203;scop](https://github.com/scop) in https://github.com/spf13/cobra/pull/1691 - perf(bash-v2): read directly to COMPREPLY on descriptionless short circuit by [@&#8203;scop](https://github.com/scop) in https://github.com/spf13/cobra/pull/1700 - fix: Don't complete \_command on zsh by [@&#8203;twpayne](https://github.com/twpayne) in https://github.com/spf13/cobra/pull/1690 - Improve fish_completions code quality by [@&#8203;t29kida](https://github.com/t29kida) in https://github.com/spf13/cobra/pull/1515 - Fix handling of descriptions for bash v3 by [@&#8203;marckhouzam](https://github.com/marckhouzam) in https://github.com/spf13/cobra/pull/1735 - undefined or nil Args default to ArbitraryArgs by [@&#8203;umarcor](https://github.com/umarcor) in https://github.com/spf13/cobra/pull/1612 - Add Command.SetContext by [@&#8203;joshcarp](https://github.com/joshcarp) in https://github.com/spf13/cobra/pull/1551 - Wrap printf tab with quotes by [@&#8203;PapaCharlie](https://github.com/PapaCharlie) in https://github.com/spf13/cobra/pull/1665 #### Documentation 📝 - Fixed typos in completions docs - [@&#8203;cuishuang](https://github.com/cuishuang) https://github.com/spf13/cobra/pull/1625 - Removed `CHANGELOG.md` as it isn't updated - [@&#8203;johnSchnake](https://github.com/johnSchnake) https://github.com/spf13/cobra/pull/1634 - Minor typo fix in `shell_completion.md` - [@&#8203;danieldn](https://github.com/danieldn) https://github.com/spf13/cobra/pull/1678 - Changed branch name in the cobra generator link to 'main' - [@&#8203;skywalker2909](https://github.com/skywalker2909) https://github.com/spf13/cobra/pull/1645 - Fix Command.Context comment by [@&#8203;katexochen](https://github.com/katexochen) in https://github.com/spf13/cobra/pull/1639 - Change appropriate links from http:// to https:// where applicable - [@&#8203;deining](https://github.com/deining) https://github.com/spf13/cobra/pull/1695 #### Testing & CI ⚙️ - Test on Golang 1.18 - [@&#8203;umarcor](https://github.com/umarcor) https://github.com/spf13/cobra/pull/1635 - Use `RICHGO_FORCE_COLOR` - [@&#8203;umarcor](https://github.com/umarcor) https://github.com/spf13/cobra/pull/1647 - Adds size labeler GitHub action by [@&#8203;jpmcb](https://github.com/jpmcb) in https://github.com/spf13/cobra/pull/1610 - Update `stale-bot` settings - [@&#8203;jpmcb](https://github.com/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 - [@&#8203;dependabot](https://github.com/dependabot) https://github.com/spf13/cobra/pull/1697 - Bump codelytv/pr-size-labeler from 1.8.0 to 1.8.1 - [@&#8203;dependabot](https://github.com/dependabot) https://github.com/spf13/cobra/pull/1661 - Bump actions/stale from 1 to 5 by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/1618 - Bump actions/cache from 2 to 3 by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/1640 - Bump actions/labeler from 3 to 4 by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/1620 - Bump golangci/golangci-lint-action from 2 to 3.1.0 by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/1615 - Bump actions/checkout from 2 to 3 by [@&#8203;dependabot](https://github.com/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 [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/1688 - Bump actions/setup-go from 2 to 3 by [@&#8203;dependabot](https://github.com/dependabot) in https://github.com/spf13/cobra/pull/1660 #### Misc 💭 - Use `errors.Is()` to check for errors - [@&#8203;Luap99](https://github.com/Luap99) https://github.com/spf13/cobra/pull/1730 - Prefer ReplaceAll instead of Replace(..., -1) by [@&#8203;WhyNotHugo](https://github.com/WhyNotHugo) in https://github.com/spf13/cobra/pull/1530 - Add Kubescape to projects - [@&#8203;avinashupadhya99](https://github.com/avinashupadhya99) https://github.com/spf13/cobra/pull/1642 - Add Pulumi as a project using cobra by [@&#8203;iwahbe](https://github.com/iwahbe) in https://github.com/spf13/cobra/pull/1720 - Add Polygon Edge as a project using Cobra by [@&#8203;zivkovicmilos](https://github.com/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**: https://github.com/spf13/cobra/compare/v1.4.0...v1.5.0 ### [`v1.4.0`](https://github.com/spf13/cobra/releases/tag/v1.4.0) [Compare Source](https://github.com/spf13/cobra/compare/v1.3.0...v1.4.0) ### 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 to `spf13/cobra-cli`](https://github.com/spf13/cobra-cli/releases/tag/v1.3.0). 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 "github.com/spf13/cobra/cobra" with "github.com/spf13/cobra-cli" And in your `go.mod`, you'll want to also include this dependency: github.com/spf13/cobra-cli v1.3.0 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 - issue: https://github.com/spf13/cobra/issues/1597 - PR: https://github.com/spf13/cobra/pull/1604 #### Documentation 📝 - Update Go Doc link and badge in README: https://github.com/spf13/cobra/pull/1593 - Fix to install command, now targets `@latest`: https://github.com/spf13/cobra/pull/1576 - Added MAINTAINERS file: https://github.com/spf13/cobra/pull/1545 #### Other 💭 - Bumped license year to 2022 in golden files: https://github.com/spf13/cobra/pull/1575 - Added Pixie to projects: https://github.com/spf13/cobra/pull/1581 - Updated labeler for new labeling scheme: https://github.com/spf13/cobra/pull/1613 & syntax fix: https://github.com/spf13/cobra/pull/1624 Shoutout to our awesome contributors helping to make this cobra release possible!! [@&#8203;spf13](https://github.com/spf13) [@&#8203;marckhouzam](https://github.com/marckhouzam) [@&#8203;johnSchnake](https://github.com/johnSchnake) [@&#8203;jpmcb](https://github.com/jpmcb) [@&#8203;liggitt](https://github.com/liggitt) [@&#8203;umarcor](https://github.com/umarcor) [@&#8203;hiljusti](https://github.com/hiljusti) [@&#8203;marians](https://github.com/marians) [@&#8203;shyim](https://github.com/shyim) [@&#8203;htroisi](https://github.com/htroisi) ### [`v1.3.0`](https://github.com/spf13/cobra/releases/tag/v1.3.0) [Compare Source](https://github.com/spf13/cobra/compare/v1.2.1...v1.3.0) ### 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 [#&#8203;1161](https://github.com/spf13/cobra/issues/1161) - Fixed unbound variables in bash completions causing edge case errors [#&#8203;1321](https://github.com/spf13/cobra/issues/1321) - `help` completion formatting improvements & fixes [#&#8203;1444](https://github.com/spf13/cobra/issues/1444) - All completions now follow the `help` example: short desc are now capitalized and removes extra spacing from long description [#&#8203;1455](https://github.com/spf13/cobra/issues/1455) - Typo fixes in bash & zsh completions [#&#8203;1459](https://github.com/spf13/cobra/issues/1459) - Fixed mixed tab/spaces indentation in completion scripts. Now just 4 spaces [#&#8203;1473](https://github.com/spf13/cobra/issues/1473) - Support for different bash completion options. Bash completions v2 supports descriptions and requires descriptions to be removed for `menu-complete`, `menu-complete-backward` and `insert-completions`. These descriptions are now purposefully removed in support of this model. [#&#8203;1509](https://github.com/spf13/cobra/issues/1509) - Fix for invalid shell completions when using `~/.cobra.yaml`. Log message `Using config file: ~/.cobra.yaml` now printed to stderr [#&#8203;1510](https://github.com/spf13/cobra/issues/1510) - Removes unnecessary trailing spaces from completion command descriptions [#&#8203;1520](https://github.com/spf13/cobra/issues/1520) - Option to hide default `completion` command [#&#8203;1541](https://github.com/spf13/cobra/issues/1541) - Remove `__complete` command for programs without subcommands [#&#8203;1563](https://github.com/spf13/cobra/issues/1563) #### Generator changes ⚙️ Thanks to [@&#8203;spf13](https://github.com/spf13) for providing a number of changes to the Cobra generator tool, streamlining it for new users! - The Cobra generator now *won't* automatically include Viper and cleans up a number of unused imports when not using Viper. - The Cobra generator's default license is now `none` - The Cobra generator now works with Go modules - Documentation to reflect these changes #### New Features ⭐ - License can be specified by their SPDX identifiers [#&#8203;1159](https://github.com/spf13/cobra/issues/1159) - `MatchAll` allows combining several PositionalArgs to work in concert. This now allows for enabling composing `PositionalArgs` [#&#8203;896](https://github.com/spf13/cobra/issues/896) #### Bug Fixes 🐛 - Fixed multiple error message from cobra `init` boilerplates [#&#8203;1463](https://github.com/spf13/cobra/issues/1463) [#&#8203;1552](https://github.com/spf13/cobra/issues/1552) [#&#8203;1557](https://github.com/spf13/cobra/issues/1557) #### Testing 👀 - Now testing golang 1.16.x and 1.17.x in CI [#&#8203;1425](https://github.com/spf13/cobra/issues/1425) - Fix for running diff test to ignore CR for windows [#&#8203;949](https://github.com/spf13/cobra/issues/949) - Added helper functions and reduced code reproduction in `args_test` [#&#8203;1426](https://github.com/spf13/cobra/issues/1426) - Now using official `golangci-lint` github action [#&#8203;1477](https://github.com/spf13/cobra/issues/1477) #### Security 🔏 - Added GitHub dependabot [#&#8203;1427](https://github.com/spf13/cobra/issues/1427) - Now using Viper `v1.10.0` - There is a known CVE in an *indirect* dependency from `viper`: https://github.com/spf13/cobra/issues/1538. This will be patched in a future release #### Documentation 📝 - Multiple projects added to the `projects_using_cobra.md` file: [#&#8203;1377](https://github.com/spf13/cobra/issues/1377) [#&#8203;1501](https://github.com/spf13/cobra/issues/1501) [#&#8203;1454](https://github.com/spf13/cobra/issues/1454) - Removed ToC from main readme file as it is now automagically displayed by GitHub [#&#8203;1429](https://github.com/spf13/cobra/issues/1429) - Documentation correct for when the `--author` flag is specified [#&#8203;1009](https://github.com/spf13/cobra/issues/1009) - `shell_completions.md` has an easier to use snippet for copying and pasting shell completions [#&#8203;1372](https://github.com/spf13/cobra/issues/1372) #### Other 💭 - Bump version of `cpuguy83/go-md2man` to v2.0.1 [#&#8203;1460](https://github.com/spf13/cobra/issues/1460) - Removed `lesser` typo from the GPL-2.0 license [#&#8203;880](https://github.com/spf13/cobra/issues/880) - Fixed spelling errors [#&#8203;1514](https://github.com/spf13/cobra/issues/1514) *Thank you to all our amazing contributors* ⭐🐍🚀 ### [`v1.2.1`](https://github.com/spf13/cobra/releases/tag/v1.2.1) [Compare Source](https://github.com/spf13/cobra/compare/v1.2.0...v1.2.1) ##### Bug fixes - Quickfix for https://github.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://github.com/spf13/cobra/releases/tag/v1.2.0): - The completions release [Compare Source](https://github.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 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 - Automatically adds a `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 *but will be deprecated* in a later 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 [#&#8203;1308](https://github.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 [@&#8203;marckhouzam](https://github.com/marckhouzam) and [@&#8203;Luap99](https://github.com/Luap99) for their hard work on a cobra command completions testing library. [Check out the repo here!](https://github.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 #### 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:** ### [`v1.1.3`](https://github.com/spf13/cobra/releases/tag/v1.1.3) [Compare Source](https://github.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://github.com/spf13/cobra/releases/tag/v1.1.2) [Compare Source](https://github.com/spf13/cobra/compare/v1.1.1...v1.1.2) ##### Notable Changes - Bump license year to 2021 in golden files ([#&#8203;1309](https://github.com/spf13/cobra/issues/1309)) [@&#8203;Bowbaq](https://github.com/Bowbaq) - Enhance PowerShell completion with custom comp ([#&#8203;1208](https://github.com/spf13/cobra/issues/1208)) [@&#8203;Luap99](https://github.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://github.com/go-yaml/yaml/issues/670) - Documentation readability improvements ([#&#8203;1228](https://github.com/spf13/cobra/issues/1228) etc.) [@&#8203;zaataylor](https://github.com/zaataylor) etc. - Use golangci-lint: Repair warnings and errors resulting from linting ([#&#8203;1044](https://github.com/spf13/cobra/issues/1044)) [@&#8203;umarcor](https://github.com/umarcor) ### [`v1.1.1`](https://github.com/spf13/cobra/releases/tag/v1.1.1) [Compare Source](https://github.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 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 for context. ### [`v1.1.0`](https://github.com/spf13/cobra/releases/tag/v1.1.0) [Compare Source](https://github.com/spf13/cobra/compare/v1.0.0...v1.1.0) #### Notable Changes - Extend Go completions and revamp zsh comp ([#&#8203;1070](https://github.com/spf13/cobra/issues/1070)) - Fix man page doc generation - no auto generated tag when `cmd.DisableAutoGenTag = true` ([#&#8203;1104](https://github.com/spf13/cobra/issues/1104)) - Add completion for help command ([#&#8203;1136](https://github.com/spf13/cobra/issues/1136)) - Complete subcommands when TraverseChildren is set ([#&#8203;1171](https://github.com/spf13/cobra/issues/1171)) - Fix stderr printing functions ([#&#8203;894](https://github.com/spf13/cobra/issues/894)) - fix: fish output redirection ([#&#8203;1247](https://github.com/spf13/cobra/issues/1247)) ### [`v1.0.0`](https://github.com/spf13/cobra/releases/tag/v1.0.0) [Compare Source](https://github.com/spf13/cobra/compare/0.0.7...v1.0.0) #### v1.0.0 Announcing v1.0.0 of Cobra. :tada: ##### Notable Changes - Fish completion (including support for Go custom completion) [@&#8203;marckhouzam](https://github.com/marckhouzam) - API (urgent): Rename BashCompDirectives to ShellCompDirectives [@&#8203;marckhouzam](https://github.com/marckhouzam) - Remove/replace SetOutput on Command - deprecated [@&#8203;jpmcb](https://github.com/jpmcb) - add support for autolabel stale PR [@&#8203;xchapter7x](https://github.com/xchapter7x) - Add Labeler Actions [@&#8203;xchapter7x](https://github.com/xchapter7x) - Custom completions coded in Go (instead of Bash) [@&#8203;marckhouzam](https://github.com/marckhouzam) - Partial Revert of [#&#8203;922](https://github.com/spf13/cobra/issues/922) [@&#8203;jharshman](https://github.com/jharshman) - Add Makefile to project [@&#8203;jharshman](https://github.com/jharshman) - Correct documentation for InOrStdin [@&#8203;desponda](https://github.com/desponda) - Apply formatting to templates [@&#8203;jharshman](https://github.com/jharshman) - Revert change so help is printed on stdout again [@&#8203;marckhouzam](https://github.com/marckhouzam) - Update md2man to v2.0.0 [@&#8203;pdf](https://github.com/pdf) - update viper to v1.4.0 [@&#8203;umarcor](https://github.com/umarcor) - Update cmd/root.go example in README.md [@&#8203;jharshman](https://github.com/jharshman) ### [`v0.0.7`](https://github.com/spf13/cobra/releases/tag/v0.0.7) [Compare Source](https://github.com/spf13/cobra/compare/v0.0.6...0.0.7) Bug fix to restore previous exit behavior when a command is not runnable. Issue Ref: [#&#8203;1056](https://github.com/spf13/cobra/issues/1056) Bug Introduced: [#&#8203;922](https://github.com/spf13/cobra/issues/922) Affected Releases: 0.0.6 ### [`v0.0.6`](https://github.com/spf13/cobra/compare/0.0.5...v0.0.6) [Compare Source](https://github.com/spf13/cobra/compare/0.0.5...v0.0.6) ### [`v0.0.5`](https://github.com/spf13/cobra/compare/v0.0.4...0.0.5) [Compare Source](https://github.com/spf13/cobra/compare/v0.0.4...0.0.5) ### [`v0.0.4`](https://github.com/spf13/cobra/releases/tag/v0.0.4): 0.0.4 [Compare Source](https://github.com/spf13/cobra/compare/v0.0.3...v0.0.4) As requested in [#&#8203;259](https://github.com/spf13/cobra/issues/259) and [#&#8203;857](https://github.com/spf13/cobra/issues/857). Changes: </details> --- ### 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 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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4yMjYuMCIsInVwZGF0ZWRJblZlciI6IjM5LjIyNi4wIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIiwibGFiZWxzIjpbXX0=-->
CSRBot added 1 commit 2025-03-31 18:09:56 +02:00
CSRBot commented 2025-03-31 18:09:58 +02:00
Author
Collaborator
Copy Link

ℹ Artifact update notice

File name: go.mod

In order to perform the update(s) described in the table above, Renovate ran the go get command, which resulted in the following additional change(s):

  • 2 additional dependencies were updated

Details:

Package Change
github.com/inconshreveable/mousetrap v1.0.0 -> v1.1.0
github.com/spf13/pflag v1.0.5 -> v1.0.6
### ℹ Artifact update notice ##### File name: go.mod In order to perform the update(s) described in the table above, Renovate ran the `go get` command, which resulted in the following additional change(s): - 2 additional dependencies were updated Details: | **Package** | **Change** | | :------------------------------------- | :------------------- | | `github.com/inconshreveable/mousetrap` | `v1.0.0` -> `v1.1.0` | | `github.com/spf13/pflag` | `v1.0.5` -> `v1.0.6` |
This pull request can be merged automatically.
You are not authorized to merge this pull request.
View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin renovate/github.com-spf13-cobra-1.x:renovate/github.com-spf13-cobra-1.x
git checkout renovate/github.com-spf13-cobra-1.x
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
CSRBot volker.raschek
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: volker.raschek/docker-hub-description-updater#3
No description provided.
Delete Branch "renovate/github.com-spf13-cobra-1.x"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?