v1.8.0

Compare Source

✨ Features

• Support usage as plugin for tools like kubectl by @​nirs in https://github.com/spf13/cobra/pull/2018 - this means that programs that utilize a "plugin-like" structure have much better support and usage (like for completions, command paths, etc.)
• Move documentation sources to site/content by @​umarcor in https://github.com/spf13/cobra/pull/1428
• Add 'one required flag' group by @​marevers in https://github.com/spf13/cobra/pull/1952 - this includes a new MarkFlagsOneRequired API for flags which can be used to mark a flag group as required and cause command failure if at least one is not used when invoked.
• Customizable error message prefix by @​5ouma in https://github.com/spf13/cobra/pull/2023 - This adds the SetErrPrefix and ErrPrefix APIs on the Command struct to allow for setting a custom prefix for errors
• feat: add getters for flag completions by @​avirtopeanu-ionos in https://github.com/spf13/cobra/pull/1943
• Feature: allow running persistent run hooks of all parents by @​vkhoroz in https://github.com/spf13/cobra/pull/2044
• Improve API to get flag completion function by @​marckhouzam in https://github.com/spf13/cobra/pull/2063

🐛 Bug fixes

• Fix typo in fish completions by @​twpayne in https://github.com/spf13/cobra/pull/1945
• Fix grammar: 'allows to' by @​supertassu in https://github.com/spf13/cobra/pull/1978
• powershell: escape variable with curly brackets by @​Luap99 in https://github.com/spf13/cobra/pull/1960
• Don't complete --help flag when flag parsing disabled by @​marckhouzam in https://github.com/spf13/cobra/pull/2061
• Replace all non-alphanumerics in active help env var program prefix by @​scop in https://github.com/spf13/cobra/pull/1940

🔧 Maintenance

• build(deps): bump golangci/golangci-lint-action from 3.4.0 to 3.5.0 by @​dependabot in https://github.com/spf13/cobra/pull/1971
• build(deps): bump golangci/golangci-lint-action from 3.5.0 to 3.6.0 by @​dependabot in https://github.com/spf13/cobra/pull/1976
• build(deps): bump golangci/golangci-lint-action from 3.6.0 to 3.7.0 by @​dependabot in https://github.com/spf13/cobra/pull/2021
• build(deps): bump actions/setup-go from 3 to 4 by @​dependabot in https://github.com/spf13/cobra/pull/1934
• build(deps): bump github.com/cpuguy83/go-md2man/v2 from 2.0.2 to 2.0.3 by @​dependabot in https://github.com/spf13/cobra/pull/2047
• build(deps): bump actions/checkout from 3 to 4 by @​dependabot in https://github.com/spf13/cobra/pull/2028
• command: temporarily disable G602 due to securego/gosec#1005 by @​umarcor in https://github.com/spf13/cobra/pull/2022

🧪 Testing & CI/CD

• test: make fish_completions_test more robust by @​branchvincent in https://github.com/spf13/cobra/pull/1980
• golangci: enable 'unused' and disable deprecated replaced by it by @​umarcor in https://github.com/spf13/cobra/pull/1983
• cleanup: minor corrections to unit tests by @​JunNishimura in https://github.com/spf13/cobra/pull/2003
• ci: test golang 1.21 by @​nunoadrego in https://github.com/spf13/cobra/pull/2024
• Fix linter errors by @​marckhouzam in https://github.com/spf13/cobra/pull/2052
• Add tests for flag completion registration by @​marckhouzam in https://github.com/spf13/cobra/pull/2053

✏️ Documentation

• doc: fix typo, Deperecated -> Deprecated by @​callthingsoff in https://github.com/spf13/cobra/pull/2000
• Add notes to doc about the execution condition of *PreRun and *PostRun functions by @​haoming29 in https://github.com/spf13/cobra/pull/2041

Thank you everyone who contributed to this release and all your hard work! Cobra and this community would never be possible without all of you!!!! 🐍

Full Changelog: spf13/cobra@v1.7.0...v1.8.0

v1.7.0

Compare Source

✨ Features

• Allow to preserve ordering of completions in bash, zsh, pwsh, & fish: @​h4ck3rk3y #​1903
• Add support for PowerShell 7.2+ in completions: @​oldium #​1916
• Allow sourcing zsh completion script: @​marckhouzam #​1917

🐛 Bug fixes

• Don't remove flag values that match sub-command name: @​brianpursley #​1781
• Fix powershell completions not returning single word: @​totkeks #​1850
• Remove masked template import variable name: @​yashLadha #​1879
• Correctly detect completions with dash in argument: @​oncilla #​1817

🧪 Testing & CI/CD

• Deprecate Go 1.15 in CI: @​umarcor #​1866
• Deprecate Go 1.16 in CI: @​umarcor #​1926
• Add testing for Go 1.20 in CI: @​umarcor #​1925
• Add tests to illustrate unknown flag bug: @​brianpursley #​1854

🔧 Maintenance

• Update main image to better handle dark backgrounds: @​Deleplace and @​marckhouzam #​1883
• Fix stale.yaml mispellings: @​enrichman #​1863
• Remove stale bot from GitHub actions: @​jpmcb #​1908
• Add makefile target for installing dependencies: @​umarcor #​1865
• Add Sia to projects using Cobra: @​mike76-dev #​1844
• Add Vitess and Arewefastyet to projects using cobra: @​frouioui #​1932
• Fixup for Kubescape github org: @​dwertent #​1874
• Fix route for GitHub workflows badge: @​sh-cho #​1884
• Fixup for GoDoc style documentation: @​yashLadha #​1885
• Various bash scripting improvements for completion: @​scop #​1702
• Add Constellation to projects using Cobra: @​datosh #​1829

✏️ Documentation

• Add documentation about disabling completion descriptions: @​Shihta #​1901
• Improve MarkFlagsMutuallyExclusive example in user guide: @​janhn #​1904
• Update shell_completions.md: @​gusega #​1907
• Update copywrite year: @​umarcor #​1927
• Document suggested layout of subcommands: @​lcarva #​1930
• Replace deprecated ExactValidArgs with MatchAll in doc: @​doniacld #​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