spf13/cobra v1.6.0

on GitHub

Summer 2022 Release

Some exciting changes make their way to Cobra! Command completions continue to get better and better (including adding --help and --version automatic flags to the completions list). Grouping is now possible in your help output as well! And you can now use the OnFinalize method to cleanup things when all "work" is done. Checkout the full changelog below:

Features 🌠

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

Deprecation 👎🏼

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

Bug fixes 🐛

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

Dependencies 🗳️

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

Testing 🤔

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

Docs ✏️

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

Misc 💭

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

Note: Per #1804, we will be moving away from "seasonal" releases and doing more generic point release targets. Continue to track the milestones and issues in the spf13/cobra GitHub repository for more information!

Great work everyone! Cobra would never be possible without your contributions! 🐍

Full Changelog: v1.5.0...v1.6.0