spf13/cobra (github.com/spf13/cobra)
### [`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: https://github.com/spf13/cobra/compare/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**: https://github.com/spf13/cobra/compare/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**: https://github.com/spf13/cobra/compare/v1.4.0...v1.5.0
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
v1.4.0->v1.7.0Release Notes
spf13/cobra (github.com/spf13/cobra)
### [`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: https://github.com/spf13/cobra/compare/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**: https://github.com/spf13/cobra/compare/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**: https://github.com/spf13/cobra/compare/v1.4.0...v1.5.0Configuration
📅 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.
This PR has been generated by Mend Renovate. View repository job log here.