Allow consuming cobra as a library without picking up viper dependencies #1597

liggitt · 2022-02-08T22:25:40Z

Status

https://github.com/spf13/cobra-cli has been created with an extracted copy of github.com/spf13/cobra/cobra/...
Initialize cobra-cli repo cobra-cli#1 renamed the command to cobra-cli
https://github.com/spf13/cobra-cli/releases/tag/v1.3.0, matching github.com/spf13/cobra v1.3.0 (except for the binary name)
PRs to update public references to cobra/cobra in go imports and scripted references
Remove CLI from this repo and update this repo's readme:
- Removes viper dependency by removing cobra/ 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:

modules: add a secondary go.mod to segregate CLI dependencies #1139

That resulted in the following issues:

There were a few problems with the previous attempt:

No new tag was created for github.com/spf13/cobra once the submodule was created, so the @latest version of both github.com/spf13/cobra and github.com/spf13/cobra/cobra provided the github.com/spf13/cobra/cobra import path. This caused the "ambiguous import" error
The submodule used a local filesystem replace ... => ../ directive, which would break go get github.com/spf13/cobra/cobra and go install github.com/spf13/cobra/cobra@latest

Proposal

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/cobra import 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:

Tag a github.com/spf13/cobra release after adding the sub go.mod so github.com/spf13/cobra@latest resolves to a version that does not provide the github.com/spf13/cobra/cobra package.
Update github.com/spf13/cobra/cobra to refer to the tagged github.com/spf13/cobra release created in step 1 so that it works with go get and go install

Testing

To test this approach, I:

cloned this repo to github.com/liggitt/cobra, and created tags at various points in cobra's history with the import paths renamed (v1.0.0, v1.1.3, and v1.3.0)
created a go.mod file at github.com/liggitt/cobra/cobra, committed and tagged as github.com/liggitt/cobra v1.5.0 - liggitt@0c686b5
updated the go.mod file at github.com/liggitt/cobra/cobra to refer to github.com/liggitt/[email protected], committed and tagged github.com/liggitt/cobra/cobra cobra/v1.5.0 - liggitt@458f3c5

Now, all of the following still work with no complaints about ambiguous import paths:

go get:

go get github.com/liggitt/cobra
go get github.com/liggitt/[email protected]
go get github.com/liggitt/[email protected]
go get github.com/liggitt/cobra@latest
go get -u github.com/liggitt/cobra
go get -u github.com/liggitt/[email protected]
go get -u github.com/liggitt/cobra@latest

go install:

go install github.com/liggitt/cobra/[email protected]
go install github.com/liggitt/cobra/[email protected]
go install github.com/liggitt/cobra/cobra@latest

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):

made copies of Kubernetes dependencies that refer to spf13/cobra@{v1.0.0,v1.1.3,v1.3.0}, and adjusted Kubernetes and the dependencies to use liggitt/cobra at the same versions
updated Kubernetes to use liggitt/[email protected]
saw a significant number of transitive dependencies drop out of our dependency graph:
- cloud.google.com/go/firestore
- github.com/DataDog/datadog-go
- github.com/armon/go-metrics
- github.com/armon/go-radix
- github.com/bgentry/speakeasy
- github.com/circonus-labs/circonus-gometrics
- github.com/circonus-labs/circonusllhist
- github.com/fatih/color
- github.com/hashicorp/consul/api
- github.com/hashicorp/consul/sdk
- github.com/hashicorp/errwrap
- github.com/hashicorp/go-cleanhttp
- github.com/hashicorp/go-hclog
- github.com/hashicorp/go-immutable-radix
- github.com/hashicorp/go-msgpack
- github.com/hashicorp/go-multierror
- github.com/hashicorp/go-retryablehttp
- github.com/hashicorp/go-rootcerts
- github.com/hashicorp/go-sockaddr
- github.com/hashicorp/go-syslog
- github.com/hashicorp/go-uuid
- github.com/hashicorp/golang-lru
- github.com/hashicorp/hcl
- github.com/hashicorp/logutils
- github.com/hashicorp/mdns
- github.com/hashicorp/memberlist
- github.com/hashicorp/serf
- github.com/magiconair/properties
- github.com/mattn/go-colorable
- github.com/mattn/go-isatty
- github.com/miekg/dns
- github.com/mitchellh/cli
- github.com/mitchellh/go-homedir
- github.com/mitchellh/go-testing-interface
- github.com/pascaldekloe/goe
- github.com/pelletier/go-toml
- github.com/posener/complete
- github.com/ryanuber/columnize
- github.com/sagikazarmark/crypt
- github.com/sean-/seed
- github.com/spf13/cast
- github.com/spf13/jwalterweatherman
- github.com/spf13/viper
- github.com/subosito/gotenv
- github.com/tv42/httpunix
- gopkg.in/ini.v1

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):

https://grep.app/search?q=%22github.com/spf13/cobra/cobra%22&filter[lang][0]=Go (4 public references in .go files)
https://grep.app/search?q=%22github.com/spf13/cobra/cobra/cmd%22 (0 public references outside of vendored copies of github.com/spf13/cobra)
https://grep.app/search?q=%22github.com/spf13/cobra/cobra/tpl%22 (0 public references outside of vendored copies of github.com/spf13/cobra)

Any consumers using these packages beyond v1.3.0 would need to depend on the github.com/spf13/cobra/cobra module 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:

create and push a v1.x.y git tag

With 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:

create and push a v1.x.y git tag
update the github.com/spf13/cobra/cobra/go.mod file to reference that version of the github.com/spf13/cobra library, go mod tidy, commit and push
create and push a cobra/v1.x.y git tag

The text was updated successfully, but these errors were encountered:

jpmcb · 2022-02-08T23:29:06Z

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 viper and it's deep dependency chain.

Let's also get @marckhouzam and @umarcor eyes on this 👀

jpmcb · 2022-02-08T23:46:53Z

FYI @spf13 - I think we will plan to move forward with this since we are getting more and more requests from kubernetes/kubernetes, helm, vmware-tanzu, etc to decouple the dependencies.

We've also seen the rise of a prominent fork which is the same as cobra but removes the interlinking of the cobra CLI and the cobra library. So, I'd also like to invite @muesli to provide their feedback and thoughts on this proposal.

jpmcb · 2022-02-09T00:07:28Z

Proposal review:

It would greatly help downstream consumers if this library could be consumed without picking up the viper dependencies.

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 kubernetes/kubernetes, helm, tanzu, etc.

History

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 main branch. If I remember correctly, this was even before go mod v2. I think that now, we are in a better place to tag the appropriate release, and get the necessary bits out in the wild where they can be consumed.

I agree with spf13 that we should avoid solutions that disrupt current consumers of the github.com/spf13/cobra import path.

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 don't appear to be very many consumers of these packages

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 two modules are effectively behaving like two distinct modules that happen to live in the same repo
...
With multiple modules, effectively, two releases would be required

⚠️ This is my only concern. This effectively makes spf13/cobra a library distribution and a consumer of it's own library. I agree this would make development work more challenging and almost creates a circular dependency. Part of me wonders if this is a better chance to remove the cobra CLI from this project and move it to it's own repo. That way, the upstream, downstream model makes much more sense. But if that isn't what we want to do, I don't think we should block on that.

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.

liggitt · 2022-02-09T00:21:36Z

This effectively makes spf13/cobra a library distribution and a consumer of it's own library.

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

I agree this would make development work more challenging and almost creates a circular dependency.

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)

Part of me wonders if this is a better chance to remove the cobra CLI from this project and move it to it's own repo. That way, the upstream, downstream model makes much more sense. But if that isn't what we want to do, I don't think we should block on that.

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.

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:

preserving the ~4 importers of the go path
preserving all the places people have scripted go get (or install) github.com/spf13/cobra/cobra to install the command

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

spf13 · 2022-02-09T01:25:52Z

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.

It should be as easy to work with as possible for the Cobra maintainers.
It should not introduce any additional dependencies for users (or any additional complications)
Let's try to not change things as much as possible.

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?

liggitt · 2022-02-09T01:33:14Z

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.

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.

I assume we'd still want something that produced a cobra binary. Does that require the last path segment to be "cobra"?

muesli · 2022-02-09T07:13:07Z

My guess is that the option that addresses these the requirements the best is to move it to it's own repo.

I believe this is the right decision here. Introducing a sub-go.mod is typically causing more issues, not only on a technical level, but also with regards to awareness and obviousness. With the CLI living in a separate repository these concerns would be eliminated.

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.

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.

caarlos0 · 2022-02-09T11:47:52Z

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.

sagikazarmark · 2022-02-09T12:41:26Z

Thanks for pinging me @spf13 !

I think I agree with most of what's been said before. I only have a couple additional thoughts:

The Cobra-Viper integration is regularly misunderstood by consumers and they often come to the Viper repo opening issues that can't be helped, so personally I fully support removing Viper as a direct dependency.
It's been a long road, but finally we have a direction at Viper: the plan is to reduce the dependencies by moving out some of the components to separate packages. I agree with @spf13 that this itself wouldn't solve the dependency problem for cobra though.
Those separate packages I mentioned will be under a go-viper/viper-go organization on GitHub (at least that's the current plan). If cobra ends up being split up as well, we might want to consider moving things under a single, CLI focused organization (even if they won't directly depend on each other)

I'd be happy to work with you to improve the situation (Cobra and Viper belong roughly to the same ecosystem after all).

liggitt · 2022-02-09T15:16:40Z

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.

doing a quick sweep of public references in https://grep.app/search?q=github.com/spf13/cobra/cobra

4 go _ imports
17 scripted installs
7 documentation references for manually installing (outside vendored copies of this repo)

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:

Create new repo, containing a copy of the current github.com/spf13/cobra/cobra/... code (I like @spf13's suggestion of cobra-cli... an install command of go install github.com/spf13/cobra-cli/cobra seems coherent and still produces a cobra binary), and tag a release (probably v1.3.0 to match the current version in this repo)
Open PRs to the public programmatic references (go imports and scripted installs)
Open issues or propose PRs updating the public documentation references found in other repos (including the example install command in this repo)
Remove github.com/spf13/cobra/cobra/... packages and tag a new version of github.com/spf13/cobra

jpmcb · 2022-02-09T16:21:57Z

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.

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.

Those separate packages I mentioned will be under a go-viper/viper-go organization on GitHub (at least that's the current plan). If cobra ends up being split up as well, we might want to consider moving things under a single, CLI focused organization (even if they won't directly depend on each other)

I had thought of doing something similar, moving cobra into a more easily administrated github organization, but that breaks the import path. How does viper plan to handle that for it's users?

Edit

I went ahead and grabbed the github.com/go-cobra org just in case we want this (now or sometime into the future)

umarcor · 2022-02-09T16:38:17Z

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:

Keep cobra as a monorepo.
Split cobra in multiple repos.
- (bis) Put those multiple repos in a namespace other than spf13's.

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.

jpmcb · 2022-02-09T16:42:16Z

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

spf13 · 2022-02-09T18:32:43Z

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).
It seems like were all also in agreement that we can decouple the cobra-cli.

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.

liggitt · 2022-02-09T18:37:09Z

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

sagikazarmark · 2022-02-09T19:46:42Z

I had thought of doing something similar, moving cobra into a more easily administrated github organization, but that breaks the import path. How does viper plan to handle that for it's users?

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

umarcor · 2022-02-09T21:29:21Z

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

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

keeping the extracted command in the same org

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

My preference for the cli is (as stated earlier) github.com/spf13/cobra-cli

@spf13, will you create github.com/spf13/cobra-docs as well?

jpmcb · 2022-02-09T21:53:15Z

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 this sounds good to me!

spf13 · 2022-02-10T02:58:32Z

ok. I've gone ahead and created the cobra-cli repo and used git subtree split to break out the entire /cobra subdirectory, thus retaining all the history in the current project.

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.

umarcor · 2022-02-10T03:03:06Z

@spf13 I meant the ./doc module that @caarlos0 mentioned above. I agree that the documentation is better kept with the main codebase (here, in cobra-cli, etc.).

liggitt · 2022-02-10T03:43:46Z

I've gone ahead and created the cobra-cli repo and used git subtree split to break out the entire /cobra subdirectory, thus retaining all the history in the current project.

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 .../cobra-cli and not .../cobra-cli/cobra. As it stands now, the repo produces a cobra-cli binary. Keeping the binary name cobra would limit changes for consumers to the install command, and leave all invocations of the binary and other docs untouched.

spf13 · 2022-02-10T13:57:59Z

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?

jpmcb · 2022-02-10T15:02:04Z

I'm in favor of naming it cobra-cli.

I agree; having a library named cobra and a CLI tool named cobra is confusing. I think if we document this change appropriately, it should be ok and new users bootstrapping with the CLI tool should discover it appropriately.

marckhouzam · 2022-03-04T12:29:29Z

opened PRs to switch the 4 projects with public go imports of github.com/spf13/cobra/cobra to cobra-cli

opened PRs to switch the public projects with scripted install / go get references to install cobra-cli or go get github.com/spf13/cobra (if they were setting up the library)

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)?

liggitt · 2022-03-04T19:23:51Z

With this done, are there any other blockers to remove the cobra generator from this repo (#1604)?

I was hoping to get at least the updates to programmatic and scripted references merged, but if there hasn't been activity on those by next week, proceeding with #1604 seems reasonable to me.

jpmcb · 2022-03-05T15:30:03Z

Most of the references (at least in the go mod files) look to not be tracking the master branch, but a previous release. So I think we could merge #1604 soon in anticipation of a release

liggitt · 2022-03-09T17:25:55Z

Most of the references (at least in the go mod files) look to not be tracking the master branch, but a previous release. So I think we could merge #1604 soon in anticipation of a release

I agree. I'm happy to see #1604 proceed at this point.

marckhouzam · 2022-03-10T02:05:04Z

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?

liggitt · 2022-03-10T02:07:18Z

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:

I really feel strongly that the import strings for both Cobra and Viper shouldn't change.

marckhouzam · 2022-03-10T02:31:04Z

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:

I really feel strongly that the import strings for both Cobra and Viper shouldn't change.

Oh right! Moving to v2 would change the import path. That is a huge deal.

So v1.4.0 is great.

umarcor · 2022-03-10T08:29:44Z

@marckhouzam @liggitt maybe you can create a 1.4.0 milestone and mark the PRs (#1565 (comment)) accordingly, as done for 1.3.0.

marckhouzam · 2022-03-10T15:37:57Z

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?

liggitt · 2022-03-10T15:39:05Z

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

jpmcb · 2022-03-10T15:39:16Z

I think we should do a v1.4.0 release now that the viper deps are out and close out #1565, focusing on #1626 going forward

marckhouzam · 2022-03-10T15:41:30Z

I think we should do a v1.4.0 release now that the viper deps are out and close out #1565, focusing on #1626 going forward

I see that everything that was originally left in the Winter release has been moved to the Spring release 😄
So the Winter release seems ready and will pretty much only contain the Viper dep removal.

jpmcb · 2022-03-10T15:42:20Z

Sweet! Drafting v1.4.0 now 👀

marckhouzam · 2022-03-10T15:45:04Z

@marckhouzam @liggitt maybe you can create a 1.4.0 milestone and mark the PRs (#1565 (comment)) accordingly, as done for 1.3.0.

I will do this.

jpmcb · 2022-03-10T15:58:27Z

https://github.com/spf13/cobra/releases/tag/v1.4.0

Great work everyone!!!! 🚀

[![WhiteSource Renovate](https://app.renovatebot.com/images/banner.svg)](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: [https://github.com/spf13/cobra/issues/1597](https://togithub.com/spf13/cobra/issues/1597) - PR: [https://github.com/spf13/cobra/pull/1604](https://togithub.com/spf13/cobra/pull/1604) #### Documentation 📝 - Update Go Doc link and badge in README: [https://github.com/spf13/cobra/pull/1593](https://togithub.com/spf13/cobra/pull/1593) - Fix to install command, now targets `@latest`: [https://github.com/spf13/cobra/pull/1576](https://togithub.com/spf13/cobra/pull/1576) - Added MAINTAINERS file: [https://github.com/spf13/cobra/pull/1545](https://togithub.com/spf13/cobra/pull/1545) #### Other 💭 - Bumped license year to 2022 in golden files: [https://github.com/spf13/cobra/pull/1575](https://togithub.com/spf13/cobra/pull/1575) - Added Pixie to projects: [https://github.com/spf13/cobra/pull/1581](https://togithub.com/spf13/cobra/pull/1581) - Updated labeler for new labeling scheme: [https://github.com/spf13/cobra/pull/1613](https://togithub.com/spf13/cobra/pull/1613) & syntax fix: [https://github.com/spf13/cobra/pull/1624](https://togithub.com/spf13/cobra/pull/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. --- - [ ] 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).

umarcor · 2022-03-10T16:29:55Z

@marckhouzam this issue is milestoned as "Next"; maybe change it to 1.4.0.

[![WhiteSource Renovate](https://app.renovatebot.com/images/banner.svg)](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: [https://github.com/spf13/cobra/issues/1597](https://togithub.com/spf13/cobra/issues/1597) - PR: [https://github.com/spf13/cobra/pull/1604](https://togithub.com/spf13/cobra/pull/1604) #### Documentation 📝 - Update Go Doc link and badge in README: [https://github.com/spf13/cobra/pull/1593](https://togithub.com/spf13/cobra/pull/1593) - Fix to install command, now targets `@latest`: [https://github.com/spf13/cobra/pull/1576](https://togithub.com/spf13/cobra/pull/1576) - Added MAINTAINERS file: [https://github.com/spf13/cobra/pull/1545](https://togithub.com/spf13/cobra/pull/1545) #### Other 💭 - Bumped license year to 2022 in golden files: [https://github.com/spf13/cobra/pull/1575](https://togithub.com/spf13/cobra/pull/1575) - Added Pixie to projects: [https://github.com/spf13/cobra/pull/1581](https://togithub.com/spf13/cobra/pull/1581) - Updated labeler for new labeling scheme: [https://github.com/spf13/cobra/pull/1613](https://togithub.com/spf13/cobra/pull/1613) & syntax fix: [https://github.com/spf13/cobra/pull/1624](https://togithub.com/spf13/cobra/pull/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`: [https://github.com/spf13/cobra/issues/1538](https://togithub.com/spf13/cobra/issues/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. --- - [ ] 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

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](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 [https://github.com/spf13/cobra/pull/2018](https://togithub.com/spf13/cobra/pull/2018) - this means that programs that utilize a "plugin-like" structure have much better support and usage (like for completions, command paths, etc.) - Move documentation sources to site/content by [@umarcor](https://togithub.com/umarcor) in [https://github.com/spf13/cobra/pull/1428](https://togithub.com/spf13/cobra/pull/1428) - Add 'one required flag' group by [@marevers](https://togithub.com/marevers) in [https://github.com/spf13/cobra/pull/1952](https://togithub.com/spf13/cobra/pull/1952) - this includes a new `MarkFlagsOneRequired` API for flags which can be used to mark a flag group as required and cause command failure if at least one is not used when invoked. - Customizable error message prefix by [@5ouma](https://togithub.com/5ouma) in [https://github.com/spf13/cobra/pull/2023](https://togithub.com/spf13/cobra/pull/2023) - This adds the `SetErrPrefix` and `ErrPrefix` APIs on the `Command` struct to allow for setting a custom prefix for errors - feat: add getters for flag completions by [@avirtopeanu-ionos](https://togithub.com/avirtopeanu-ionos) in [https://github.com/spf13/cobra/pull/1943](https://togithub.com/spf13/cobra/pull/1943) - Feature: allow running persistent run hooks of all parents by [@vkhoroz](https://togithub.com/vkhoroz) in [https://github.com/spf13/cobra/pull/2044](https://togithub.com/spf13/cobra/pull/2044) - Improve API to get flag completion function by [@marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/2063](https://togithub.com/spf13/cobra/pull/2063) #### 🐛 Bug fixes - Fix typo in fish completions by [@twpayne](https://togithub.com/twpayne) in [https://github.com/spf13/cobra/pull/1945](https://togithub.com/spf13/cobra/pull/1945) - Fix grammar: 'allows to' by [@supertassu](https://togithub.com/supertassu) in [https://github.com/spf13/cobra/pull/1978](https://togithub.com/spf13/cobra/pull/1978) - powershell: escape variable with curly brackets by [@Luap99](https://togithub.com/Luap99) in [https://github.com/spf13/cobra/pull/1960](https://togithub.com/spf13/cobra/pull/1960) - Don't complete --help flag when flag parsing disabled by [@marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/2061](https://togithub.com/spf13/cobra/pull/2061) - Replace all non-alphanumerics in active help env var program prefix by [@scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1940](https://togithub.com/spf13/cobra/pull/1940) #### 🔧 Maintenance - build(deps): bump golangci/golangci-lint-action from 3.4.0 to 3.5.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1971](https://togithub.com/spf13/cobra/pull/1971) - build(deps): bump golangci/golangci-lint-action from 3.5.0 to 3.6.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1976](https://togithub.com/spf13/cobra/pull/1976) - build(deps): bump golangci/golangci-lint-action from 3.6.0 to 3.7.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/2021](https://togithub.com/spf13/cobra/pull/2021) - build(deps): bump actions/setup-go from 3 to 4 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1934](https://togithub.com/spf13/cobra/pull/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 [https://github.com/spf13/cobra/pull/2047](https://togithub.com/spf13/cobra/pull/2047) - build(deps): bump actions/checkout from 3 to 4 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/2028](https://togithub.com/spf13/cobra/pull/2028) - command: temporarily disable G602 due to [securego/gosec#1005](https://togithub.com/securego/gosec/issues/1005) by [@umarcor](https://togithub.com/umarcor) in [https://github.com/spf13/cobra/pull/2022](https://togithub.com/spf13/cobra/pull/2022) #### 🧪 Testing & CI/CD - test: make fish_completions_test more robust by [@branchvincent](https://togithub.com/branchvincent) in [https://github.com/spf13/cobra/pull/1980](https://togithub.com/spf13/cobra/pull/1980) - golangci: enable 'unused' and disable deprecated replaced by it by [@umarcor](https://togithub.com/umarcor) in [https://github.com/spf13/cobra/pull/1983](https://togithub.com/spf13/cobra/pull/1983) - cleanup: minor corrections to unit tests by [@JunNishimura](https://togithub.com/JunNishimura) in [https://github.com/spf13/cobra/pull/2003](https://togithub.com/spf13/cobra/pull/2003) - ci: test golang 1.21 by [@nunoadrego](https://togithub.com/nunoadrego) in [https://github.com/spf13/cobra/pull/2024](https://togithub.com/spf13/cobra/pull/2024) - Fix linter errors by [@marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/2052](https://togithub.com/spf13/cobra/pull/2052) - Add tests for flag completion registration by [@marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/2053](https://togithub.com/spf13/cobra/pull/2053) #### ✏️ Documentation - doc: fix typo, Deperecated -> Deprecated by [@callthingsoff](https://togithub.com/callthingsoff) in [https://github.com/spf13/cobra/pull/2000](https://togithub.com/spf13/cobra/pull/2000) - Add notes to doc about the execution condition of \*PreRun and \*PostRun functions by [@haoming29](https://togithub.com/haoming29) in [https://github.com/spf13/cobra/pull/2041](https://togithub.com/spf13/cobra/pull/2041) *** Thank you everyone who contributed to this release and all your hard work! Cobra and this community would never be possible without all of you!!!! 🐍 **Full Changelog**: spf13/cobra@v1.7.0...v1.8.0 ### [`v1.7.0`](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 [https://github.com/spf13/cobra/pull/1482](https://togithub.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](https://togithub.com/johnSchnake) for this! [https://github.com/spf13/cobra/pull/1654](https://togithub.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://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 [https://github.com/spf13/cobra/pull/1547](https://togithub.com/spf13/cobra/pull/1547) - feat: Add how to load completions in your current zsh session by [@ondrejsika](https://togithub.com/ondrejsika) in [https://github.com/spf13/cobra/pull/1608](https://togithub.com/spf13/cobra/pull/1608) - Introduce FixedCompletions by [@emersion](https://togithub.com/emersion) in [https://github.com/spf13/cobra/pull/1574](https://togithub.com/spf13/cobra/pull/1574) - Add shell completion to flag groups by [@marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/1659](https://togithub.com/spf13/cobra/pull/1659) - Modify brew prefix path in macOS system by [@imxw](https://togithub.com/imxw) in [https://github.com/spf13/cobra/pull/1719](https://togithub.com/spf13/cobra/pull/1719) - perf(bash-v2): use backslash escape string expansion for tab by [@scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1682](https://togithub.com/spf13/cobra/pull/1682) - style(bash-v2): out is not an array variable, do not refer to it as such by [@scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1681](https://togithub.com/spf13/cobra/pull/1681) - perf(bash-v2): standard completion optimizations by [@scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1683](https://togithub.com/spf13/cobra/pull/1683) - style(bash): out is not an array variable, do not refer to it as such by [@scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1684](https://togithub.com/spf13/cobra/pull/1684) - perf(bash-v2): short-circuit descriptionless candidate lists by [@scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1686](https://togithub.com/spf13/cobra/pull/1686) - perf(bash-v2): speed up filtering entries with descriptions by [@scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1689](https://togithub.com/spf13/cobra/pull/1689) - perf(bash-v2): speed up filtering menu-complete descriptions by [@scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1692](https://togithub.com/spf13/cobra/pull/1692) - fix(bash-v2): skip empty completions when filtering descriptions by [@scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1691](https://togithub.com/spf13/cobra/pull/1691) - perf(bash-v2): read directly to COMPREPLY on descriptionless short circuit by [@scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1700](https://togithub.com/spf13/cobra/pull/1700) - fix: Don't complete \_command on zsh by [@twpayne](https://togithub.com/twpayne) in [https://github.com/spf13/cobra/pull/1690](https://togithub.com/spf13/cobra/pull/1690) - Improve fish_completions code quality by [@t29kida](https://togithub.com/t29kida) in [https://github.com/spf13/cobra/pull/1515](https://togithub.com/spf13/cobra/pull/1515) - Fix handling of descriptions for bash v3 by [@marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/1735](https://togithub.com/spf13/cobra/pull/1735) - undefined or nil Args default to ArbitraryArgs by [@umarcor](https://togithub.com/umarcor) in [https://github.com/spf13/cobra/pull/1612](https://togithub.com/spf13/cobra/pull/1612) - Add Command.SetContext by [@joshcarp](https://togithub.com/joshcarp) in [https://github.com/spf13/cobra/pull/1551](https://togithub.com/spf13/cobra/pull/1551) - Wrap printf tab with quotes by [@PapaCharlie](https://togithub.com/PapaCharlie) in [https://github.com/spf13/cobra/pull/1665](https://togithub.com/spf13/cobra/pull/1665) #### Documentation 📝 - Fixed typos in completions docs - [@cuishuang](https://togithub.com/cuishuang) [https://github.com/spf13/cobra/pull/1625](https://togithub.com/spf13/cobra/pull/1625) - Removed `CHANGELOG.md` as it isn't updated - [@johnSchnake](https://togithub.com/johnSchnake) [https://github.com/spf13/cobra/pull/1634](https://togithub.com/spf13/cobra/pull/1634) - Minor typo fix in `shell_completion.md` - [@danieldn](https://togithub.com/danieldn) [https://github.com/spf13/cobra/pull/1678](https://togithub.com/spf13/cobra/pull/1678) - Changed branch name in the cobra generator link to 'main' - [@skywalker2909](https://togithub.com/skywalker2909) [https://github.com/spf13/cobra/pull/1645](https://togithub.com/spf13/cobra/pull/1645) - Fix Command.Context comment by [@katexochen](https://togithub.com/katexochen) in [https://github.com/spf13/cobra/pull/1639](https://togithub.com/spf13/cobra/pull/1639) - Change appropriate links from http:// to https:// where applicable - [@deining](https://togithub.com/deining) [https://github.com/spf13/cobra/pull/1695](https://togithub.com/spf13/cobra/pull/1695) #### Testing & CI ⚙️ - Test on Golang 1.18 - [@umarcor](https://togithub.com/umarcor) [https://github.com/spf13/cobra/pull/1635](https://togithub.com/spf13/cobra/pull/1635) - Use `RICHGO_FORCE_COLOR` - [@umarcor](https://togithub.com/umarcor) [https://github.com/spf13/cobra/pull/1647](https://togithub.com/spf13/cobra/pull/1647) - Adds size labeler GitHub action by [@jpmcb](https://togithub.com/jpmcb) in [https://github.com/spf13/cobra/pull/1610](https://togithub.com/spf13/cobra/pull/1610) - Update `stale-bot` settings - [@jpmcb](https://togithub.com/jpmcb) [https://github.com/spf13/cobra/pull/1609](https://togithub.com/spf13/cobra/pull/1609) #### Beep boop, bot commits 🤖 - Bumped golangci/golangci-lint-action from 3.1.0 to 3.2.0 - [@dependabot](https://togithub.com/dependabot) [https://github.com/spf13/cobra/pull/1697](https://togithub.com/spf13/cobra/pull/1697) - Bump codelytv/pr-size-labeler from 1.8.0 to 1.8.1 - [@dependabot](https://togithub.com/dependabot) [https://github.com/spf13/cobra/pull/1661](https://togithub.com/spf13/cobra/pull/1661) - Bump actions/stale from 1 to 5 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1618](https://togithub.com/spf13/cobra/pull/1618) - Bump actions/cache from 2 to 3 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1640](https://togithub.com/spf13/cobra/pull/1640) - Bump actions/labeler from 3 to 4 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1620](https://togithub.com/spf13/cobra/pull/1620) - Bump golangci/golangci-lint-action from 2 to 3.1.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1615](https://togithub.com/spf13/cobra/pull/1615) - Bump actions/checkout from 2 to 3 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1619](https://togithub.com/spf13/cobra/pull/1619) - Bump github.com/cpuguy83/go-md2man/v2 from 2.0.1 to 2.0.2 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1688](https://togithub.com/spf13/cobra/pull/1688) - Bump actions/setup-go from 2 to 3 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1660](https://togithub.com/spf13/cobra/pull/1660) #### Misc 💭 - Use `errors.Is()` to check for errors - [@Luap99](https://togithub.com/Luap99) [https://github.com/spf13/cobra/pull/1730](https://togithub.com/spf13/cobra/pull/1730) - Prefer ReplaceAll instead of Replace(..., -1) by [@WhyNotHugo](https://togithub.com/WhyNotHugo) in [https://github.com/spf13/cobra/pull/1530](https://togithub.com/spf13/cobra/pull/1530) - Add Kubescape to projects - [@avinashupadhya99](https://togithub.com/avinashupadhya99) [https://github.com/spf13/cobra/pull/1642](https://togithub.com/spf13/cobra/pull/1642) - Add Pulumi as a project using cobra by [@iwahbe](https://togithub.com/iwahbe) in [https://github.com/spf13/cobra/pull/1720](https://togithub.com/spf13/cobra/pull/1720) - Add Polygon Edge as a project using Cobra by [@zivkovicmilos](https://togithub.com/zivkovicmilos) in [https://github.com/spf13/cobra/pull/1672](https://togithub.com/spf13/cobra/pull/1672) Shoutout to *ALL* our contributors (and all the new first time contributors!!) - great work everyone!! Cobra and it's huge impact wouldn't be possible without you 👏🏼 🚀 🐍 **Full Changelog**: spf13/cobra@v1.4.0...v1.5.0 ### [`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: [https://github.com/spf13/cobra/issues/1597](https://togithub.com/spf13/cobra/issues/1597) - PR: [https://github.com/spf13/cobra/pull/1604](https://togithub.com/spf13/cobra/pull/1604) #### Documentation 📝 - Update Go Doc link and badge in README: [https://github.com/spf13/cobra/pull/1593](https://togithub.com/spf13/cobra/pull/1593) - Fix to install command, now targets `@latest`: [https://github.com/spf13/cobra/pull/1576](https://togithub.com/spf13/cobra/pull/1576) - Added MAINTAINERS file: [https://github.com/spf13/cobra/pull/1545](https://togithub.com/spf13/cobra/pull/1545) #### Other 💭 - Bumped license year to 2022 in golden files: [https://github.com/spf13/cobra/pull/1575](https://togithub.com/spf13/cobra/pull/1575) - Added Pixie to projects: [https://github.com/spf13/cobra/pull/1581](https://togithub.com/spf13/cobra/pull/1581) - Updated labeler for new labeling scheme: [https://github.com/spf13/cobra/pull/1613](https://togithub.com/spf13/cobra/pull/1613) & syntax fix: [https://github.com/spf13/cobra/pull/1624](https://togithub.com/spf13/cobra/pull/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`: [https://github.com/spf13/cobra/issues/1538](https://togithub.com/spf13/cobra/issues/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 [https://github.com/spf13/cobra/issues/1437](https://togithub.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://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 [https://github.com/spf13/cobra/pull/1192](https://togithub.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](https://togithub.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](https://togithub.com/spf13/cobra/pull/1265) - An example can be found here: [https://github.com/spf13/cobra/pull/1265#issuecomment-734551031](https://togithub.com/spf13/cobra/pull/1265#issuecomment-734551031) - 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 [https://github.com/spf13/cobra/pull/1342](https://togithub.com/spf13/cobra/pull/1342) - Bash completion variable leak fix [https://github.com/spf13/cobra/pull/1352](https://togithub.com/spf13/cobra/pull/1352) - Fish shell completions correctly ignore trailing empty lines [https://github.com/spf13/cobra/pull/1284](https://togithub.com/spf13/cobra/pull/1284) - PowerShell completions fix for "no file comp directive" - [https://github.com/spf13/cobra/pull/1363](https://togithub.com/spf13/cobra/pull/1363) - Custom completions now correctly handle multiple shorthand flags together - [https://github.com/spf13/cobra/pull/1258](https://togithub.com/spf13/cobra/pull/1258) - zsh completions now correctly handle `ShellDirectiveCompletionNoSpace` and file completion all the time - [https://github.com/spf13/cobra/pull/1213](https://togithub.com/spf13/cobra/pull/1213) - Multiple fixes / improvements to the fish shell support - [https://github.com/spf13/cobra/pull/1249](https://togithub.com/spf13/cobra/pull/1249) - Fix home directory config not loading correctly - [https://github.com/spf13/cobra/pull/1282](https://togithub.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](https://togithub.com/spf13/cobra/pull/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 - [https://github.com/spf13/cobra/pull/1433](https://togithub.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](https://togithub.com/spf13/cobra/pull/1338) - CI using MSYS2 windows machines pull latest - [https://github.com/spf13/cobra/pull/1366](https://togithub.com/spf13/cobra/pull/1366) - Multiple small fixes to spelling / documentation - [https://github.com/spf13/cobra/pull/1349](https://togithub.com/spf13/cobra/pull/1349) [https://github.com/spf13/cobra/pull/1417](https://togithub.com/spf13/cobra/pull/1417) [https://github.com/spf13/cobra/pull/1434](https://togithub.com/spf13/cobra/pull/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. --- - [ ] 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).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

This was referenced Feb 8, 2022

Update Cobra from 1.2.1 to 1.3.0 kubernetes/kubernetes#107628

Closed

Cobra pull a lot of dependencies through viper #1138

Closed

1.2.0 deps explosion? #1435

Closed

Reorganise the cobra library and the CLI as siblings #1240

Closed

jpmcb pinned this issue Feb 8, 2022

jpmcb added this to the Next milestone Feb 8, 2022

liggitt mentioned this issue Feb 10, 2022

Initialize cobra-cli repo spf13/cobra-cli#1

Merged

This was referenced Mar 3, 2022

Update reference to github.com/spf13/cobra/cobra codeedu/imersao-fullcycle-3#3

Open

Switch to standalone cobra-cli dependency awslabs/tecli#14

Merged

brianpursley mentioned this issue Mar 4, 2022

Update Cobra to version 1.3.0 kubernetes/kubectl#1166

Closed

jpmcb closed this as completed Mar 10, 2022

marckhouzam modified the milestones: Next, 1.4.0 Mar 10, 2022

yuwenma mentioned this issue Mar 23, 2022

Bump cobra dependency to pick up latest vulnerability solution kubernetes-sigs/kustomize#4527

Merged

jpmcb mentioned this issue Apr 8, 2022

Upgrade viper to remove CVE found in indeirect dependencies #1538

Closed

umarcor mentioned this issue Sep 16, 2022

refactor: mv cmd/* ./ spf13/cobra-cli#48

Open

liggitt mentioned this issue Nov 9, 2022

Use current fsnotify library, drop viper dependency cncf-tags/container-device-interface#95

Merged

Allow consuming cobra as a library without picking up viper dependencies #1597

Allow consuming cobra as a library without picking up viper dependencies #1597

Comments

liggitt commented Feb 8, 2022 • edited Loading

Status

History

Proposal

Testing

Impact on library consumers

Impact on library consumers of github.com/spf13/cobra/cobra/...

Impact on development

Impact on release mechanics

jpmcb commented Feb 8, 2022

jpmcb commented Feb 8, 2022

jpmcb commented Feb 9, 2022

Proposal review:

liggitt commented Feb 9, 2022 • edited Loading

spf13 commented Feb 9, 2022

liggitt commented Feb 9, 2022 • edited Loading

muesli commented Feb 9, 2022

caarlos0 commented Feb 9, 2022

sagikazarmark commented Feb 9, 2022

liggitt commented Feb 9, 2022 • edited Loading

jpmcb commented Feb 9, 2022 • edited Loading

umarcor commented Feb 9, 2022

jpmcb commented Feb 9, 2022

spf13 commented Feb 9, 2022

liggitt commented Feb 9, 2022

sagikazarmark commented Feb 9, 2022

umarcor commented Feb 9, 2022

jpmcb commented Feb 9, 2022

spf13 commented Feb 10, 2022

umarcor commented Feb 10, 2022 • edited Loading

liggitt commented Feb 10, 2022 • edited Loading

spf13 commented Feb 10, 2022 via email

jpmcb commented Feb 10, 2022

marckhouzam commented Mar 4, 2022

liggitt commented Mar 4, 2022

jpmcb commented Mar 5, 2022

liggitt commented Mar 9, 2022

marckhouzam commented Mar 10, 2022

liggitt commented Mar 10, 2022 • edited Loading

marckhouzam commented Mar 10, 2022

umarcor commented Mar 10, 2022

marckhouzam commented Mar 10, 2022

liggitt commented Mar 10, 2022 • edited Loading

jpmcb commented Mar 10, 2022

marckhouzam commented Mar 10, 2022

jpmcb commented Mar 10, 2022

marckhouzam commented Mar 10, 2022

jpmcb commented Mar 10, 2022

umarcor commented Mar 10, 2022 • edited Loading

liggitt commented Feb 8, 2022 •

edited

Loading

Impact on library consumers of `github.com/spf13/cobra/cobra/...`

liggitt commented Feb 9, 2022 •

edited

Loading

liggitt commented Feb 9, 2022 •

edited

Loading

liggitt commented Feb 9, 2022 •

edited

Loading

jpmcb commented Feb 9, 2022 •

edited

Loading

umarcor commented Feb 10, 2022 •

edited

Loading

liggitt commented Feb 10, 2022 •

edited

Loading

liggitt commented Mar 10, 2022 •

edited

Loading

liggitt commented Mar 10, 2022 •

edited

Loading

umarcor commented Mar 10, 2022 •

edited

Loading