Allow consuming cobra as a library without picking up viper dependencies #1597
Comments
|
Thanks for the in depth research on this! Pinning since I think this issue is the most fresh in regards to how we pull in Let's also get @marckhouzam and @umarcor eyes on this 👀 |
|
FYI @spf13 - I think we will plan to move forward with this since we are getting more and more requests from We've also seen the rise of a prominent fork which is the same as cobra but removes the interlinking of the |
Proposal review:
100% agree. This is a long standing problem and something that has been challenging for downstream consumers and maintainers to keep ontop of. Further, it only exacerbates a challenging secure supply chain issue: we shouldn't be bringing unnecessary dependencies into
Also note that at the time we attempted this, cobra did not have a release cycle and it was expected that users would pull off of the
Yes, I 100% agree. There are far too many large projects downstream that rely on the library import path and we do not have the open source bandwidth to advocate those projects change their import path.
There shouldn't be since it's primary purpose is to bootstrap a new cobra program via it's CLI. I'd say anyone that is using it should transition to using the library directly.
The release cadences are already difficult (given we need an injection of engineering and maintainer resources). So If at all possible, it'd be great if this wasn't made more difficult. My only suggestion is that we consider moving the cobra CLI to it's own repository. If @spf13 doesn't have bandwidth to do that, I'd be happy to provide a repo and also maintain it along side this library. And if we don't want to remove it, I think your proposal is extremely solid and would work in the long run. |
it would be a multi-module repo (https://go.dev/doc/modules/managing-source#multiple-module-source), where each module gets its own lifecycle/tags/etc, and only refers to the other modules in the same repo via committed/published tags
Fortunately, the dependency is still directed, not circular (command depends on library), but yeah, it could make development across the two modules more difficult (though no different from multi-repo development, if a release of the library is required before library changes are picked up and used by the command)
Note that the "two release" aspect isn't required to happen in lockstep, only when you want the command module to pick up and start making use of changes added to the library module The only real pros I can think of for keeping the command in the same repo are:
That second one (the install command) might be significant… I suspect you'd get a lot of reports of breakage if the current install method stopped working |
|
I fully support moving to having viper not imported by default. Honestly that decision was made very VERY early in the lifecycle of Go and I don't think any of us understood how dependencies would have played out. I also had no idea how popular this little library of mine would become. FWIW, The viper folks are working on a version that dramatically reduces it's dependencies as well. This should minimize, but not eliminate the problem that we're addressing here. cc: @sagikazarmark for his input and visibility. For separating the CLI from the library, I'm not sure what the right answer is but have a few requirements.
My guess is that the option that addresses these the requirements the best is to move it to it's own repo. Very little coordination happens between the CLI and the library because the CLI is very simple. Not having to worry about multiple modules in a repo is simpler. The only disadvantage I see is that all documentation around Cobra CLI will point to the wrong install string. This is unfortunate, but I think we can message this okay. I'm much more concerned about breaking dependencies that are automated things vs something that a human is manually doing. We can inform the human of a new installation command. If we go down this route we should put it at github.com/spf13/cobra-cli (or similar) so it's still discoverable when people look for spf13/cobra. Am I missing anything or not thinking about it correctly? |
|
From a library consumer and cobra maintainer perspective, moving the CLI to a separate repo is certainly easy to reason about, accomplishes the dependency reduction goals for the library, and is simpler to maintain. If we're confident all (or the majority) of installation invocations are done by humans we can inform, and not scripted in automation we'll break, that sounds reasonable. I'm not familiar enough with use of the CLI side of this repo to know if that's the case.
I assume we'd still want something that produced a |
I believe this is the right decision here. Introducing a sub-
I completely agree with this 👍 I'd also like to point out that in my (admittedly limited and personal) experience only a fraction of Cobra's users are actually using the CLI tool. It's definitely nice to have when experimenting with Cobra in the beginning, but once you figured out how this library works most everyone I work with gets by without using the CLI. If that's not just my "personal anecdote" it's probably another good indicator the CLI should be moved to a separate repository. |
|
Another good candidate to be a separated module: the docs and man page generators. IMHO, ideally they should be interfaces the user can implement themselves, or import packages that does it for them. This way we could drop even more transitive dependencies, and also allow for more customization. |
|
Thanks for pinging me @spf13 ! I think I agree with most of what's been said before. I only have a couple additional thoughts:
I'd be happy to work with you to improve the situation (Cobra and Viper belong roughly to the same ecosystem after all). |
doing a quick sweep of public references in https://grep.app/search?q=github.com/spf13/cobra/cobra
That's a small enough number we could plausibly open PRs to fix the references to point to the new repo containing the command. I'd be in favor of this order of operations:
|
From supporting this project over the last few years, this has been my experience too. Alot of users get started with the CLI, but they quickly move on to just using the library.
I had thought of doing something similar, moving cobra into a more easily administrated github organization, but that breaks the import path. How does Edit I went ahead and grabbed the |
|
IMHO, the cobra library itself should be isolated from other optional and less used components. Unfortunately, there is no way to achieve it without introducing breaking changes, because those sources are in the root of the current repository. I believe there are two decisions to make:
In order to avoid breaking changes, the only solution is to keep the monorepo and increase the maintenance burden. My preference is to move cobra to the snakes org, AND move the lib to a subdir. Both at the same time. Probably consider applying other breaking changes (if any) at the same time. |
This is an anti-goal of this operation. We should not induce more user pain than will already be felt by possibly changing the import path, removing dependencies, or introducing a different way to get the |
|
I really feel strongly that the import strings for both Cobra and Viper shouldn't change. They have way too large adoption to justify this change. Cobra is imported over 51k times. Viper over 27k times. This is an overwhelmingly high number of users to consider making a breaking change. github.com/spf13/cobra and github.com/spf13/viper need to stay where they are. I'm supportive of having extraneous components moved to different repos as it will simplify things for our maintainers and likely our users as well. If we limit this to things that aren't currently directly imported then we can improve things for everyone without breaking anyone. This is the ideal direction to take. I concur with many of you. Cobra-cli isn't very widely used and the vast majority of usage is when you are starting a new application. It's really not very useful once the application is bootstrapped. I don't think it would even be problematic to rename it to cobra-cli. If anything, it might actually make some things clearer in the documentation (once revised). I think we're all in agreement that the implicit dependency on viper should be removed (the topic of this thread). Both of these are big steps in the right direction. It might be worth moving forward with these two steps and keep thinking about the best way to approach further steps. My preference for the cli is (as stated earlier) github.com/spf13/cobra-cli and give access to all the same people as cobra. I'm happy to set this up. I think that this is the simplest path forward for users and it would be the easiest to discover. |
+1 I think keeping the extracted command in the same org will make it easier to convince consumers to accept updates to docs/scripts to point to the new location. As a data point, if someone came to Kubernetes with a PR trying to update a dependency to pull it from a different org, I'd need to vet the new org, make sure it was official, understand which was more up-to-date / canonical, etc. It would definitely be more work and friction than: - github.com/spf13/cobra/cobra
+ github.com/spf13/cobra-cli/cobra |
@jpmcb The core library will stay where it is. Extracted components will be moved under the new organization. As @spf13 mentioned, keeping things backwards compatible as much as possible is an important goal. |
@jpmcb, I believe it's better to have 2-3 breaking changes once and explain them clear enough, rather than having them go through pain for 1-2y. Anyway, it seems the majority decided to move the subdirs away and preserve the root.
@liggitt, note that 'spf13' is not an organisation, but a user. That is probably irrelevant from golang's perspective, but is meaningful from a management point of view.
@spf13, will you create github.com/spf13/cobra-docs as well? |
+1 this sounds good to me! |
|
ok. I've gone ahead and created the cobra-cli repo and used I've given access to all existing contributors and added @liggitt too. This should give us a good working foundation to make the proposed changes. We still need to add things like a license, update the readme and then update the old repo and remove the directory there. @umarcor I'm a bit more concerned about pulling the docs out as unlike the generator which really has barely changed, the docs need to keep in step with the main codebase. A very convenient way to do that is keep them in the same repo. The website (cobra.dev) is already in it's own repo. I'd like a few others to weigh in before making this one. |
I'm happy to open an initial PR to rename import paths in that repo, copy over the license and create a starting go.mod file, etc - spf13/cobra-cli#1 Before we merge anything to that repo, I wanted to make sure we were set with the leaf package containing the new cli being |
|
I’m on the fence about this. I think the current name is actually quite
confusing as there isn’t a clear distinction between the library and the
tool. Just read the read me and I think you might agree. Since we are
making a change it’s probably the best time to address this mistake too
with clearly distinct names.
The biggest issue I see is that the config file name will need to be
changed too but that’s easily fixed and we could support both the old and
new name there. I’m not sure if anyone other than me even uses that
feature. 😊
What do others think?
|
|
I'm in favor of naming it I agree; having a library named |
Thank you so much @liggitt for doing this! With this done, are there any other blockers to remove the cobra generator from this repo (#1604)? |
|
Most of the references (at least in the go mod files) look to not be tracking the |
|
I was wondering about the next release version. Does removing the Cobra generator require us to bump the major version? We are not actually breaking anyone that integrates the Cobra library, and bumping the major version sends a signal that people have work to do to move to the new release (when it is not actually the case). This may unnecessarily slow down adoption. I would personally prefer going for a v1.4.0 release. What do others think? |
|
v1.4.0 is what I anticipated, not a v2 that changes the import path from #1597 (comment), it sounds like @spf13 expected the same:
|
Oh right! Moving to v2 would change the import path. That is a huge deal. So v1.4.0 is great. |
|
@marckhouzam @liggitt maybe you can create a |
|
Do we want a quick release for the removal of the Viper dependency, or do we want to lump it in the original "Winter" release? |
|
if the winter 2022 release was going to be 1.4.0, lumping it in and going ahead and tagging makes sense to me... we're only 11 days from spring 2022 anyway |
I see that everything that was originally left in the Winter release has been moved to the Spring release 😄 |
|
Sweet! Drafting |
I will do this. |
|
https://github.com/spf13/cobra/releases/tag/v1.4.0 Great work everyone!!!! 🚀 |
[](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/spf13/cobra](https://togithub.com/spf13/cobra) | require | minor | `v1.3.0` -> `v1.4.0` | --- ### Release Notes <details> <summary>spf13/cobra</summary> ### [`v1.4.0`](https://togithub.com/spf13/cobra/releases/v1.4.0) [Compare Source](https://togithub.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 it's indirect dependencies. This means that Cobra's dependency tree has been drastically thinned! The Viper dependency was included because of the the `cobra` CLI generation tool. [This tool has migrated to `spf13/cobra-cli`](https://togithub.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: [spf13/cobra#1597 - PR: [spf13/cobra#1604 #### Documentation 📝 - Update Go Doc link and badge in README: [spf13/cobra#1593 - Fix to install command, now targets `@latest`: [spf13/cobra#1576 - Added MAINTAINERS file: [spf13/cobra#1545 #### Other 💭 - Bumped license year to 2022 in golden files: [spf13/cobra#1575 - Added Pixie to projects: [spf13/cobra#1581 - Updated labeler for new labeling scheme: [spf13/cobra#1613 & syntax fix: [spf13/cobra#1624 Shoutout to our awesome contributors helping to make this cobra release possible!! [@​spf13](https://togithub.com/spf13) [@​marckhouzam](https://togithub.com/marckhouzam) [@​johnSchnake](https://togithub.com/johnSchnake) [@​jpmcb](https://togithub.com/jpmcb) [@​liggitt](https://togithub.com/liggitt) [@​umarcor](https://togithub.com/umarcor) [@​hiljusti](https://togithub.com/hiljusti) [@​marians](https://togithub.com/marians) [@​shyim](https://togithub.com/shyim) [@​htroisi](https://togithub.com/htroisi) </details> --- ### Configuration 📅 **Schedule**: 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, click this checkbox. --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/gapic-showcase).
|
@marckhouzam this issue is milestoned as "Next"; maybe change it to 1.4.0. |
[](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/spf13/cobra](https://togithub.com/spf13/cobra) | require | minor | `v1.2.1` -> `v1.4.0` | --- ### Release Notes <details> <summary>spf13/cobra</summary> ### [`v1.4.0`](https://togithub.com/spf13/cobra/releases/v1.4.0) [Compare Source](https://togithub.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://togithub.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: [spf13/cobra#1597 - PR: [spf13/cobra#1604 #### Documentation 📝 - Update Go Doc link and badge in README: [spf13/cobra#1593 - Fix to install command, now targets `@latest`: [spf13/cobra#1576 - Added MAINTAINERS file: [spf13/cobra#1545 #### Other 💭 - Bumped license year to 2022 in golden files: [spf13/cobra#1575 - Added Pixie to projects: [spf13/cobra#1581 - Updated labeler for new labeling scheme: [spf13/cobra#1613 & syntax fix: [spf13/cobra#1624 Shoutout to our awesome contributors helping to make this cobra release possible!! [@​spf13](https://togithub.com/spf13) [@​marckhouzam](https://togithub.com/marckhouzam) [@​johnSchnake](https://togithub.com/johnSchnake) [@​jpmcb](https://togithub.com/jpmcb) [@​liggitt](https://togithub.com/liggitt) [@​umarcor](https://togithub.com/umarcor) [@​hiljusti](https://togithub.com/hiljusti) [@​marians](https://togithub.com/marians) [@​shyim](https://togithub.com/shyim) [@​htroisi](https://togithub.com/htroisi) ### [`v1.3.0`](https://togithub.com/spf13/cobra/releases/v1.3.0) [Compare Source](https://togithub.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 [#​1161](https://togithub.com/spf13/cobra/issues/1161) - Fixed unbound variables in bash completions causing edge case errors [#​1321](https://togithub.com/spf13/cobra/issues/1321) - `help` completion formatting improvements & fixes [#​1444](https://togithub.com/spf13/cobra/issues/1444) - All completions now follow the `help` example: short desc are now capitalized and removes extra spacing from long description [#​1455](https://togithub.com/spf13/cobra/issues/1455) - Typo fixes in bash & zsh completions [#​1459](https://togithub.com/spf13/cobra/issues/1459) - Fixed mixed tab/spaces indentation in completion scripts. Now just 4 spaces [#​1473](https://togithub.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. [#​1509](https://togithub.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 [#​1510](https://togithub.com/spf13/cobra/issues/1510) - Removes unnecessary trailing spaces from completion command descriptions [#​1520](https://togithub.com/spf13/cobra/issues/1520) - Option to hide default `completion` command [#​1541](https://togithub.com/spf13/cobra/issues/1541) - Remove `__complete` command for programs without subcommands [#​1563](https://togithub.com/spf13/cobra/issues/1563) #### Generator changes ⚙️ Thanks to [@​spf13](https://togithub.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 [#​1159](https://togithub.com/spf13/cobra/issues/1159) - `MatchAll` allows combining several PositionalArgs to work in concert. This now allows for enabling composing `PositionalArgs` [#​896](https://togithub.com/spf13/cobra/issues/896) #### Bug Fixes 🐛 - Fixed multiple error message from cobra `init` boilerplates [#​1463](https://togithub.com/spf13/cobra/issues/1463) [#​1552](https://togithub.com/spf13/cobra/issues/1552) [#​1557](https://togithub.com/spf13/cobra/issues/1557) #### Testing 👀 - Now testing golang 1.16.x and 1.17.x in CI [#​1425](https://togithub.com/spf13/cobra/issues/1425) - Fix for running diff test to ignore CR for windows [#​949](https://togithub.com/spf13/cobra/issues/949) - Added helper functions and reduced code reproduction in `args_test` [#​1426](https://togithub.com/spf13/cobra/issues/1426) - Now using official `golangci-lint` github action [#​1477](https://togithub.com/spf13/cobra/issues/1477) #### Security 🔏 - Added GitHub dependabot [#​1427](https://togithub.com/spf13/cobra/issues/1427) - Now using Viper `v1.10.0` - There is a known CVE in an *indirect* dependency from `viper`: [spf13/cobra#1538. This will be patched in a future release #### Documentation 📝 - Multiple projects added to the `projects_using_cobra.md` file: [#​1377](https://togithub.com/spf13/cobra/issues/1377) [#​1501](https://togithub.com/spf13/cobra/issues/1501) [#​1454](https://togithub.com/spf13/cobra/issues/1454) - Removed ToC from main readme file as it is now automagically displayed by GitHub [#​1429](https://togithub.com/spf13/cobra/issues/1429) - Documentation correct for when the `--author` flag is specified [#​1009](https://togithub.com/spf13/cobra/issues/1009) - `shell_completions.md` has an easier to use snippet for copying and pasting shell completions [#​1372](https://togithub.com/spf13/cobra/issues/1372) #### Other 💭 - Bump version of `cpuguy83/go-md2man` to v2.0.1 [#​1460](https://togithub.com/spf13/cobra/issues/1460) - Removed `lesser` typo from the GPL-2.0 license [#​880](https://togithub.com/spf13/cobra/issues/880) - Fixed spelling errors [#​1514](https://togithub.com/spf13/cobra/issues/1514) *Thank you to all our amazing contributors* ⭐🐍🚀 </details> --- ### Configuration 📅 **Schedule**: 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, click this checkbox. --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/GoogleCloudPlatform/alloydb-auth-proxy).
Earlier Viper was being pulled in by Cobra, and hence wasn't explicitly
listed as a BuildRequires. However, Cobra 1.4.0 removed the Viper
dependency [1], so it needs to be explicitly listed.
There's no need to do a build just for this.
[1] Cobra commit 5b2b9e9f61d36ccb
spf13/cobra#1597
](https://renovatebot.com){kind=link}
[](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/spf13/cobra](https://togithub.com/spf13/cobra) | require | minor | `v1.1.3` -> `v1.8.0` | --- ### Release Notes <details> <summary>spf13/cobra (github.com/spf13/cobra)</summary> ### [`v1.8.0`](https://togithub.com/spf13/cobra/releases/tag/v1.8.0) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.7.0...v1.8.0) #### ✨ Features - Support usage as plugin for tools like kubectl by [@​nirs](https://togithub.com/nirs) in [spf13/cobra#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](https://togithub.com/umarcor) in [spf13/cobra#1428 - Add 'one required flag' group by [@​marevers](https://togithub.com/marevers) in [spf13/cobra#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](https://togithub.com/5ouma) in [spf13/cobra#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](https://togithub.com/avirtopeanu-ionos) in [spf13/cobra#1943 - Feature: allow running persistent run hooks of all parents by [@​vkhoroz](https://togithub.com/vkhoroz) in [spf13/cobra#2044 - Improve API to get flag completion function by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#2063 #### 🐛 Bug fixes - Fix typo in fish completions by [@​twpayne](https://togithub.com/twpayne) in [spf13/cobra#1945 - Fix grammar: 'allows to' by [@​supertassu](https://togithub.com/supertassu) in [spf13/cobra#1978 - powershell: escape variable with curly brackets by [@​Luap99](https://togithub.com/Luap99) in [spf13/cobra#1960 - Don't complete --help flag when flag parsing disabled by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#2061 - Replace all non-alphanumerics in active help env var program prefix by [@​scop](https://togithub.com/scop) in [spf13/cobra#1940 #### 🔧 Maintenance - build(deps): bump golangci/golangci-lint-action from 3.4.0 to 3.5.0 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1971 - build(deps): bump golangci/golangci-lint-action from 3.5.0 to 3.6.0 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1976 - build(deps): bump golangci/golangci-lint-action from 3.6.0 to 3.7.0 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#2021 - build(deps): bump actions/setup-go from 3 to 4 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1934 - build(deps): bump github.com/cpuguy83/go-md2man/v2 from 2.0.2 to 2.0.3 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#2047 - build(deps): bump actions/checkout from 3 to 4 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#2028 - command: temporarily disable G602 due to [securego/gosec#1005](https://togithub.com/securego/gosec/issues/1005) by [@​umarcor](https://togithub.com/umarcor) in [spf13/cobra#2022 #### 🧪 Testing & CI/CD - test: make fish_completions_test more robust by [@​branchvincent](https://togithub.com/branchvincent) in [spf13/cobra#1980 - golangci: enable 'unused' and disable deprecated replaced by it by [@​umarcor](https://togithub.com/umarcor) in [spf13/cobra#1983 - cleanup: minor corrections to unit tests by [@​JunNishimura](https://togithub.com/JunNishimura) in [spf13/cobra#2003 - ci: test golang 1.21 by [@​nunoadrego](https://togithub.com/nunoadrego) in [spf13/cobra#2024 - Fix linter errors by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#2052 - Add tests for flag completion registration by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#2053 #### ✏️ Documentation - doc: fix typo, Deperecated -> Deprecated by [@​callthingsoff](https://togithub.com/callthingsoff) in [spf13/cobra#2000 - Add notes to doc about the execution condition of \*PreRun and \*PostRun functions by [@​haoming29](https://togithub.com/haoming29) in [spf13/cobra#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`](https://togithub.com/spf13/cobra/releases/tag/v1.7.0) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.6.1...v1.7.0) ##### ✨ Features - Allow to preserve ordering of completions in `bash`, `zsh`, `pwsh`, & `fish`: [@​h4ck3rk3y](https://togithub.com/h4ck3rk3y) [#​1903](https://togithub.com/spf13/cobra/issues/1903) - Add support for PowerShell 7.2+ in completions: [@​oldium](https://togithub.com/oldium) [#​1916](https://togithub.com/spf13/cobra/issues/1916) - Allow sourcing zsh completion script: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1917](https://togithub.com/spf13/cobra/issues/1917) ##### 🐛 Bug fixes - Don't remove flag values that match sub-command name: [@​brianpursley](https://togithub.com/brianpursley) [#​1781](https://togithub.com/spf13/cobra/issues/1781) - Fix powershell completions not returning single word: [@​totkeks](https://togithub.com/totkeks) [#​1850](https://togithub.com/spf13/cobra/issues/1850) - Remove masked `template` import variable name: [@​yashLadha](https://togithub.com/yashLadha) [#​1879](https://togithub.com/spf13/cobra/issues/1879) - Correctly detect completions with dash in argument: [@​oncilla](https://togithub.com/oncilla) [#​1817](https://togithub.com/spf13/cobra/issues/1817) ##### 🧪 Testing & CI/CD - Deprecate Go 1.15 in CI: [@​umarcor](https://togithub.com/umarcor) [#​1866](https://togithub.com/spf13/cobra/issues/1866) - Deprecate Go 1.16 in CI: [@​umarcor](https://togithub.com/umarcor) [#​1926](https://togithub.com/spf13/cobra/issues/1926) - Add testing for Go 1.20 in CI: [@​umarcor](https://togithub.com/umarcor) [#​1925](https://togithub.com/spf13/cobra/issues/1925) - Add tests to illustrate unknown flag bug: [@​brianpursley](https://togithub.com/brianpursley) [#​1854](https://togithub.com/spf13/cobra/issues/1854) ##### 🔧 Maintenance - Update main image to better handle dark backgrounds: [@​Deleplace](https://togithub.com/Deleplace) and [@​marckhouzam](https://togithub.com/marckhouzam) [#​1883](https://togithub.com/spf13/cobra/issues/1883) - Fix `stale.yaml` mispellings: [@​enrichman](https://togithub.com/enrichman) [#​1863](https://togithub.com/spf13/cobra/issues/1863) - Remove stale bot from GitHub actions: [@​jpmcb](https://togithub.com/jpmcb) [#​1908](https://togithub.com/spf13/cobra/issues/1908) - Add makefile target for installing dependencies: [@​umarcor](https://togithub.com/umarcor) [#​1865](https://togithub.com/spf13/cobra/issues/1865) - Add Sia to projects using Cobra: [@​mike76-dev](https://togithub.com/mike76-dev) [#​1844](https://togithub.com/spf13/cobra/issues/1844) - Add `Vitess` and `Arewefastyet` to projects using cobra: [@​frouioui](https://togithub.com/frouioui) [#​1932](https://togithub.com/spf13/cobra/issues/1932) - Fixup for Kubescape github org: [@​dwertent](https://togithub.com/dwertent) [#​1874](https://togithub.com/spf13/cobra/issues/1874) - Fix route for GitHub workflows badge: [@​sh-cho](https://togithub.com/sh-cho) [#​1884](https://togithub.com/spf13/cobra/issues/1884) - Fixup for GoDoc style documentation: [@​yashLadha](https://togithub.com/yashLadha) [#​1885](https://togithub.com/spf13/cobra/issues/1885) - Various bash scripting improvements for completion: [@​scop](https://togithub.com/scop) [#​1702](https://togithub.com/spf13/cobra/issues/1702) - Add Constellation to projects using Cobra: [@​datosh](https://togithub.com/datosh) [#​1829](https://togithub.com/spf13/cobra/issues/1829) ##### ✏️ Documentation - Add documentation about disabling completion descriptions: [@​Shihta](https://togithub.com/Shihta) [#​1901](https://togithub.com/spf13/cobra/issues/1901) - Improve `MarkFlagsMutuallyExclusive` example in user guide: [@​janhn](https://togithub.com/janhn) [#​1904](https://togithub.com/spf13/cobra/issues/1904) - Update `shell_completions.md`: [@​gusega](https://togithub.com/gusega) [#​1907](https://togithub.com/spf13/cobra/issues/1907) - Update copywrite year: [@​umarcor](https://togithub.com/umarcor) [#​1927](https://togithub.com/spf13/cobra/issues/1927) - Document suggested layout of subcommands: [@​lcarva](https://togithub.com/lcarva) [#​1930](https://togithub.com/spf13/cobra/issues/1930) - Replace deprecated ExactValidArgs with MatchAll in doc: [@​doniacld](https://togithub.com/doniacld) [#​1836](https://togithub.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: spf13/cobra@v1.6.1...v1.7.0 ### [`v1.6.1`](https://togithub.com/spf13/cobra/releases/tag/v1.6.1) [Compare Source](https://togithub.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 - [@​marckhouzam](https://togithub.com/marckhouzam) (and shout out to [@​aawsome](https://togithub.com/aawsome), [@​andig](https://togithub.com/andig) and [@​KINGSABRI](https://togithub.com/KINGSABRI) for a deep investigation into this! 👏🏼) ### [`v1.6.0`](https://togithub.com/spf13/cobra/releases/tag/v1.6.0) [Compare Source](https://togithub.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: [@​aawsome](https://togithub.com/aawsome) [@​marckhouzam](https://togithub.com/marckhouzam) [#​1003](https://togithub.com/spf13/cobra/issues/1003) - Support for case-insensitive command names: [@​YuviGold](https://togithub.com/YuviGold) [#​1802](https://togithub.com/spf13/cobra/issues/1802) - Expose `ValidateRequiredFlags` and `ValidateFlagGroups`: [@​skeetwu](https://togithub.com/skeetwu) [#​1760](https://togithub.com/spf13/cobra/issues/1760) - Add `--version` flag to help output: [@​fnickels](https://togithub.com/fnickels) [#​1707](https://togithub.com/spf13/cobra/issues/1707) - Add `--help` and `--version` flag in completions: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1813](https://togithub.com/spf13/cobra/issues/1813) - Add `OnFinalize` method: [@​yann-soubeyrand](https://togithub.com/yann-soubeyrand) [#​1788](https://togithub.com/spf13/cobra/issues/1788) - Allow user to add completion for powershell alias: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1621](https://togithub.com/spf13/cobra/issues/1621) - Make `InitDefaultcompletionCmd` public: [@​gssbzn](https://togithub.com/gssbzn) [#​1467](https://togithub.com/spf13/cobra/issues/1467) ##### Deprecation 👎🏼 - `ExactValidArgs` is deprecated (but not being removed entirely). This is abit nuanced, so checkout [#​1643](https://togithub.com/spf13/cobra/issues/1643) for further information and the [updated `user_guide.md`](https://togithub.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): [@​umarcor](https://togithub.com/umarcor) [#​1643](https://togithub.com/spf13/cobra/issues/1643) ##### Bug fixes 🐛 - Fix (bash-v2) `activeHelp` length check syntax: [@​scop](https://togithub.com/scop) [#​1762](https://togithub.com/spf13/cobra/issues/1762) - Fix correct command path in `see_also` for yaml documentation: [@​zregvart](https://togithub.com/zregvart) [#​1771](https://togithub.com/spf13/cobra/issues/1771) - Fix showing flags that shadow parent persistent flag in child help messaging: [@​brianpursley](https://togithub.com/brianpursley) [#​1776](https://togithub.com/spf13/cobra/issues/1776) ##### Dependencies 🗳️ - Upgrade to use `gopkg.in/yaml.v3`: [@​tklauser](https://togithub.com/tklauser) [#​1766](https://togithub.com/spf13/cobra/issues/1766) ##### Testing 🤔 - Test on Golang 1.19: [@​umarcor](https://togithub.com/umarcor) & [@​jpmcb](https://togithub.com/jpmcb) [#​1782](https://togithub.com/spf13/cobra/issues/1782) - Renamed powershell completion tests: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1803](https://togithub.com/spf13/cobra/issues/1803) - Use `action/setup-go` cache: [@​umarcor](https://togithub.com/umarcor) [#​1783](https://togithub.com/spf13/cobra/issues/1783) - Add `workflow_dispatch` to CI actions: [@​umarcor](https://togithub.com/umarcor) [#​1387](https://togithub.com/spf13/cobra/issues/1387) - Add minimum GitHub token permissions for workflows: [@​varunsh-coder](https://togithub.com/varunsh-coder) [#​1792](https://togithub.com/spf13/cobra/issues/1792) ##### Docs ✏️ - Fixup spelling for GitHub CLI: [@​eltociear](https://togithub.com/eltociear) [#​1744](https://togithub.com/spf13/cobra/issues/1744) - Clarify `SetContext` documentation: [@​katexochen](https://togithub.com/katexochen) [#​1748](https://togithub.com/spf13/cobra/issues/1748) - Instruct user to `go install` for binary: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1726](https://togithub.com/spf13/cobra/issues/1726) - User guide cleanup: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1656](https://togithub.com/spf13/cobra/issues/1656) - Document option to hide the default completion command: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1779](https://togithub.com/spf13/cobra/issues/1779) ##### Misc 💭 - Add KubeVirt, CloudQuery, Cilium, Okteto, Zitadel, Allero to projects using cobra: [@​maiqueb](https://togithub.com/maiqueb) [#​1741](https://togithub.com/spf13/cobra/issues/1741), [@​yevgenypats](https://togithub.com/yevgenypats) [#​1742](https://togithub.com/spf13/cobra/issues/1742), [@​tklauser](https://togithub.com/tklauser) [#​1745](https://togithub.com/spf13/cobra/issues/1745), [@​jLopezbarb](https://togithub.com/jLopezbarb) [#​1759](https://togithub.com/spf13/cobra/issues/1759), [@​fforootd](https://togithub.com/fforootd) [#​1772](https://togithub.com/spf13/cobra/issues/1772), [@​dimabru](https://togithub.com/dimabru) [#​1819](https://togithub.com/spf13/cobra/issues/1819) - Use correct stale action `exempt` yaml keys: [@​jpmcb](https://togithub.com/jpmcb) [#​1800](https://togithub.com/spf13/cobra/issues/1800) - Add missing license headers: [@​umarcor](https://togithub.com/umarcor) [#​1809](https://togithub.com/spf13/cobra/issues/1809) *Note:* Per [#​1804](https://togithub.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**: spf13/cobra@v1.5.0...v1.6.0 ### [`v1.5.0`](https://togithub.com/spf13/cobra/releases/tag/v1.5.0) [Compare Source](https://togithub.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 [@​marckhouzam](https://togithub.com/marckhouzam) for a big value add: Active Help [spf13/cobra#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](https://togithub.com/johnSchnake) for this! [spf13/cobra#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://togithub.com/spf13/cobra/blob/master/user_guide.md) for further info! #### Completions 👀 - Add backwards-compatibility tests for legacyArgs() by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#1547 - feat: Add how to load completions in your current zsh session by [@​ondrejsika](https://togithub.com/ondrejsika) in [spf13/cobra#1608 - Introduce FixedCompletions by [@​emersion](https://togithub.com/emersion) in [spf13/cobra#1574 - Add shell completion to flag groups by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#1659 - Modify brew prefix path in macOS system by [@​imxw](https://togithub.com/imxw) in [spf13/cobra#1719 - perf(bash-v2): use backslash escape string expansion for tab by [@​scop](https://togithub.com/scop) in [spf13/cobra#1682 - style(bash-v2): out is not an array variable, do not refer to it as such by [@​scop](https://togithub.com/scop) in [spf13/cobra#1681 - perf(bash-v2): standard completion optimizations by [@​scop](https://togithub.com/scop) in [spf13/cobra#1683 - style(bash): out is not an array variable, do not refer to it as such by [@​scop](https://togithub.com/scop) in [spf13/cobra#1684 - perf(bash-v2): short-circuit descriptionless candidate lists by [@​scop](https://togithub.com/scop) in [spf13/cobra#1686 - perf(bash-v2): speed up filtering entries with descriptions by [@​scop](https://togithub.com/scop) in [spf13/cobra#1689 - perf(bash-v2): speed up filtering menu-complete descriptions by [@​scop](https://togithub.com/scop) in [spf13/cobra#1692 - fix(bash-v2): skip empty completions when filtering descriptions by [@​scop](https://togithub.com/scop) in [spf13/cobra#1691 - perf(bash-v2): read directly to COMPREPLY on descriptionless short circuit by [@​scop](https://togithub.com/scop) in [spf13/cobra#1700 - fix: Don't complete \_command on zsh by [@​twpayne](https://togithub.com/twpayne) in [spf13/cobra#1690 - Improve fish_completions code quality by [@​t29kida](https://togithub.com/t29kida) in [spf13/cobra#1515 - Fix handling of descriptions for bash v3 by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#1735 - undefined or nil Args default to ArbitraryArgs by [@​umarcor](https://togithub.com/umarcor) in [spf13/cobra#1612 - Add Command.SetContext by [@​joshcarp](https://togithub.com/joshcarp) in [spf13/cobra#1551 - Wrap printf tab with quotes by [@​PapaCharlie](https://togithub.com/PapaCharlie) in [spf13/cobra#1665 #### Documentation 📝 - Fixed typos in completions docs - [@​cuishuang](https://togithub.com/cuishuang) [spf13/cobra#1625 - Removed `CHANGELOG.md` as it isn't updated - [@​johnSchnake](https://togithub.com/johnSchnake) [spf13/cobra#1634 - Minor typo fix in `shell_completion.md` - [@​danieldn](https://togithub.com/danieldn) [spf13/cobra#1678 - Changed branch name in the cobra generator link to 'main' - [@​skywalker2909](https://togithub.com/skywalker2909) [spf13/cobra#1645 - Fix Command.Context comment by [@​katexochen](https://togithub.com/katexochen) in [spf13/cobra#1639 - Change appropriate links from http:// to https:// where applicable - [@​deining](https://togithub.com/deining) [spf13/cobra#1695 #### Testing & CI ⚙️ - Test on Golang 1.18 - [@​umarcor](https://togithub.com/umarcor) [spf13/cobra#1635 - Use `RICHGO_FORCE_COLOR` - [@​umarcor](https://togithub.com/umarcor) [spf13/cobra#1647 - Adds size labeler GitHub action by [@​jpmcb](https://togithub.com/jpmcb) in [spf13/cobra#1610 - Update `stale-bot` settings - [@​jpmcb](https://togithub.com/jpmcb) [spf13/cobra#1609 #### Beep boop, bot commits 🤖 - Bumped golangci/golangci-lint-action from 3.1.0 to 3.2.0 - [@​dependabot](https://togithub.com/dependabot) [spf13/cobra#1697 - Bump codelytv/pr-size-labeler from 1.8.0 to 1.8.1 - [@​dependabot](https://togithub.com/dependabot) [spf13/cobra#1661 - Bump actions/stale from 1 to 5 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1618 - Bump actions/cache from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1640 - Bump actions/labeler from 3 to 4 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1620 - Bump golangci/golangci-lint-action from 2 to 3.1.0 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1615 - Bump actions/checkout from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1619 - Bump github.com/cpuguy83/go-md2man/v2 from 2.0.1 to 2.0.2 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1688 - Bump actions/setup-go from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1660 #### Misc 💭 - Use `errors.Is()` to check for errors - [@​Luap99](https://togithub.com/Luap99) [spf13/cobra#1730 - Prefer ReplaceAll instead of Replace(..., -1) by [@​WhyNotHugo](https://togithub.com/WhyNotHugo) in [spf13/cobra#1530 - Add Kubescape to projects - [@​avinashupadhya99](https://togithub.com/avinashupadhya99) [spf13/cobra#1642 - Add Pulumi as a project using cobra by [@​iwahbe](https://togithub.com/iwahbe) in [spf13/cobra#1720 - Add Polygon Edge as a project using Cobra by [@​zivkovicmilos](https://togithub.com/zivkovicmilos) in [spf13/cobra#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 ### [`v1.4.0`](https://togithub.com/spf13/cobra/releases/tag/v1.4.0) [Compare Source](https://togithub.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://togithub.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: [spf13/cobra#1597 - PR: [spf13/cobra#1604 #### Documentation 📝 - Update Go Doc link and badge in README: [spf13/cobra#1593 - Fix to install command, now targets `@latest`: [spf13/cobra#1576 - Added MAINTAINERS file: [spf13/cobra#1545 #### Other 💭 - Bumped license year to 2022 in golden files: [spf13/cobra#1575 - Added Pixie to projects: [spf13/cobra#1581 - Updated labeler for new labeling scheme: [spf13/cobra#1613 & syntax fix: [spf13/cobra#1624 Shoutout to our awesome contributors helping to make this cobra release possible!! [@​spf13](https://togithub.com/spf13) [@​marckhouzam](https://togithub.com/marckhouzam) [@​johnSchnake](https://togithub.com/johnSchnake) [@​jpmcb](https://togithub.com/jpmcb) [@​liggitt](https://togithub.com/liggitt) [@​umarcor](https://togithub.com/umarcor) [@​hiljusti](https://togithub.com/hiljusti) [@​marians](https://togithub.com/marians) [@​shyim](https://togithub.com/shyim) [@​htroisi](https://togithub.com/htroisi) ### [`v1.3.0`](https://togithub.com/spf13/cobra/releases/tag/v1.3.0) [Compare Source](https://togithub.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 [#​1161](https://togithub.com/spf13/cobra/issues/1161) - Fixed unbound variables in bash completions causing edge case errors [#​1321](https://togithub.com/spf13/cobra/issues/1321) - `help` completion formatting improvements & fixes [#​1444](https://togithub.com/spf13/cobra/issues/1444) - All completions now follow the `help` example: short desc are now capitalized and removes extra spacing from long description [#​1455](https://togithub.com/spf13/cobra/issues/1455) - Typo fixes in bash & zsh completions [#​1459](https://togithub.com/spf13/cobra/issues/1459) - Fixed mixed tab/spaces indentation in completion scripts. Now just 4 spaces [#​1473](https://togithub.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. [#​1509](https://togithub.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 [#​1510](https://togithub.com/spf13/cobra/issues/1510) - Removes unnecessary trailing spaces from completion command descriptions [#​1520](https://togithub.com/spf13/cobra/issues/1520) - Option to hide default `completion` command [#​1541](https://togithub.com/spf13/cobra/issues/1541) - Remove `__complete` command for programs without subcommands [#​1563](https://togithub.com/spf13/cobra/issues/1563) #### Generator changes ⚙️ Thanks to [@​spf13](https://togithub.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 [#​1159](https://togithub.com/spf13/cobra/issues/1159) - `MatchAll` allows combining several PositionalArgs to work in concert. This now allows for enabling composing `PositionalArgs` [#​896](https://togithub.com/spf13/cobra/issues/896) #### Bug Fixes 🐛 - Fixed multiple error message from cobra `init` boilerplates [#​1463](https://togithub.com/spf13/cobra/issues/1463) [#​1552](https://togithub.com/spf13/cobra/issues/1552) [#​1557](https://togithub.com/spf13/cobra/issues/1557) #### Testing 👀 - Now testing golang 1.16.x and 1.17.x in CI [#​1425](https://togithub.com/spf13/cobra/issues/1425) - Fix for running diff test to ignore CR for windows [#​949](https://togithub.com/spf13/cobra/issues/949) - Added helper functions and reduced code reproduction in `args_test` [#​1426](https://togithub.com/spf13/cobra/issues/1426) - Now using official `golangci-lint` github action [#​1477](https://togithub.com/spf13/cobra/issues/1477) #### Security 🔏 - Added GitHub dependabot [#​1427](https://togithub.com/spf13/cobra/issues/1427) - Now using Viper `v1.10.0` - There is a known CVE in an *indirect* dependency from `viper`: [spf13/cobra#1538. This will be patched in a future release #### Documentation 📝 - Multiple projects added to the `projects_using_cobra.md` file: [#​1377](https://togithub.com/spf13/cobra/issues/1377) [#​1501](https://togithub.com/spf13/cobra/issues/1501) [#​1454](https://togithub.com/spf13/cobra/issues/1454) - Removed ToC from main readme file as it is now automagically displayed by GitHub [#​1429](https://togithub.com/spf13/cobra/issues/1429) - Documentation correct for when the `--author` flag is specified [#​1009](https://togithub.com/spf13/cobra/issues/1009) - `shell_completions.md` has an easier to use snippet for copying and pasting shell completions [#​1372](https://togithub.com/spf13/cobra/issues/1372) #### Other 💭 - Bump version of `cpuguy83/go-md2man` to v2.0.1 [#​1460](https://togithub.com/spf13/cobra/issues/1460) - Removed `lesser` typo from the GPL-2.0 license [#​880](https://togithub.com/spf13/cobra/issues/880) - Fixed spelling errors [#​1514](https://togithub.com/spf13/cobra/issues/1514) *Thank you to all our amazing contributors* ⭐🐍🚀 ### [`v1.2.1`](https://togithub.com/spf13/cobra/releases/tag/v1.2.1) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.2.0...v1.2.1) ##### Bug fixes - Quickfix for [spf13/cobra#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://togithub.com/spf13/cobra/releases/tag/v1.2.0): - The completions release [Compare Source](https://togithub.com/spf13/cobra/compare/v1.1.3...v1.2.0) ### 🌠 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 [spf13/cobra#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 - [spf13/cobra#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 - [spf13/cobra#1265 - An example can be found here: [spf13/cobra#1265 (comment) - Removed dependency on`mitchellh/go-homedir` in favor of core Go `os.UserHomeDir()` - spf13/cobra@8eaca5f #### Bug Fixes - Fix trailing whitespace not being handled in powershell completion scripts [spf13/cobra#1342 - Bash completion variable leak fix [spf13/cobra#1352 - Fish shell completions correctly ignore trailing empty lines [spf13/cobra#1284 - PowerShell completions fix for "no file comp directive" - [spf13/cobra#1363 - Custom completions now correctly handle multiple shorthand flags together - [spf13/cobra#1258 - zsh completions now correctly handle `ShellDirectiveCompletionNoSpace` and file completion all the time - [spf13/cobra#1213 - Multiple fixes / improvements to the fish shell support - [spf13/cobra#1249 - Fix home directory config not loading correctly - [spf13/cobra#1282 - Fix for `RegisterFlagCompletionFunc` as a global var not working in multi-threaded programs: [spf13/cobra#1423 - Custom completions correctly do not complete flags after args when interspersed is false [#​1308](https://togithub.com/spf13/cobra/issues/1308) #### Testing - Deprecated Travis CI. Now fully using Github Actions - spf13/cobra@d0f318d - Added test cases and enhancements (thank you to everyone for taking the time to add tests to your PRs!) - Shoutout to [@​marckhouzam](https://togithub.com/marckhouzam) and [@​Luap99](https://togithub.com/Luap99) for their hard work on a cobra command completions testing library. [Check out the repo here!](https://togithub.com/marckhouzam/cobra-completion-testing) #### Security - Bump viper to 1.8.1. This corrects several issues with vulnerabilities existing in the dependency tree - [spf13/cobra#1433 #### Other - Add PR labeler with pull_request_target to enable tests to run from forks - [spf13/cobra#1338 - CI using MSYS2 windows machines pull latest - [spf13/cobra#1366 - Multiple small fixes to spelling / documentation - [spf13/cobra#1349 [spf13/cobra#1417 [spf13/cobra#1434 **Thank you to *all* our amazing contributors 🐍🚀** </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 becomes conflicted, 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 [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/PingCAP-QE/ee-apps). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy44Ny4yIiwidXBkYXRlZEluVmVyIjoiMzcuODcuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Status
cobra-clitoolsto standalone cobra-cli dependency wormhole-foundation/wormhole#936toolsto standalone cobra-cli dependency shihanng/gig#56viperdependency by removingcobra/CLI tool #1604(original description follows)
First, many thanks for such a useful command library. The widespread adoption demonstrates how useful it is. A consequence of being very popular is that any dependencies of this module are picked up as transitive dependencies by a lot of consumers. The github.com/spf13/viper dependency of the cobra command line tool is particularly problematic, as it pulls in large numbers of large dependencies.
It would greatly help downstream consumers if this library could be consumed without picking up the viper dependencies.
History
Relevant existing issues:
There was a prior attempt at isolating the CLI command and viper dependency via a submodule:
That resulted in the following issues:
There were a few problems with the previous attempt:
github.com/spf13/cobraonce the submodule was created, so the@latestversion of bothgithub.com/spf13/cobraandgithub.com/spf13/cobra/cobraprovided thegithub.com/spf13/cobra/cobraimport path. This caused the "ambiguous import" errorreplace ... => ../directive, which would breakgo get github.com/spf13/cobra/cobraandgo install github.com/spf13/cobra/cobra@latestProposal
2022-03-10 note: rather than the approach proposed here, the Cobra CLI was split to a separate repo at https://github.com/spf13/cobra-cli. See discussion starting at #1597 (comment)
Possible solutions for reorganizing this library to isolate the viper dependency are discussed in #1240. I agree with @spf13 that we should avoid solutions that disrupt current consumers of the
github.com/spf13/cobraimport path.I think the previous attempt to create a dedicated module for the cobra command packages (
github.com/spf13/cobra/cobra/...) was the right direction, and could resolve the problems with the previous attempt with two changes:github.com/spf13/cobrarelease after adding the sub go.mod sogithub.com/spf13/cobra@latestresolves to a version that does not provide thegithub.com/spf13/cobra/cobrapackage.github.com/spf13/cobra/cobrato refer to the taggedgithub.com/spf13/cobrarelease created in step 1 so that it works withgo getandgo installTesting
To test this approach, I:
github.com/liggitt/cobra/cobra, committed and tagged asgithub.com/liggitt/cobrav1.5.0 - liggitt@0c686b5github.com/liggitt/cobra/cobrato refer togithub.com/liggitt/cobra@v1.5.0, committed and taggedgithub.com/liggitt/cobra/cobracobra/v1.5.0 - liggitt@458f3c5Now, all of the following still work with no complaints about ambiguous import paths:
go get:go install:Impact on library consumers
To see what the impact would be on downstream consumers of this library, I took Kubernetes' use as an example (test commits visible in https://github.com/liggitt/kubernetes/commits/cobra130):
Impact on library consumers of
github.com/spf13/cobra/cobra/...There don't appear to be very many consumers of these packages (which is not surprising, since their purpose is to support the cobra command line):
Any consumers using these packages beyond v1.3.0 would need to depend on the
github.com/spf13/cobra/cobramodule instead.Impact on development
Changes that span the two modules would become more difficult to make, and could not be committed/pushed in a single PR. This is because the two modules are effectively behaving like two distinct modules that happen to live in the same repo, and a release of the library module would be required before the command module could start relying on the changes in it via a publicly referenced version.
Impact on release mechanics
Currently, to release github.com/spf13/cobra:
v1.x.ygit tagWith multiple modules, effectively, two releases would be required (one for the library and one for the command), which would require two tags and a go.mod change:
v1.x.ygit taggithub.com/spf13/cobra/cobra/go.modfile to reference that version of thegithub.com/spf13/cobralibrary,go mod tidy, commit and pushcobra/v1.x.ygit tagThe text was updated successfully, but these errors were encountered: