Bump spf13/cobra to 1.8.0 and adapt PersistentPreRun usage #3693

kke · 2023-11-07T09:03:44Z

Bumps github.com/spf13/cobra from 1.7.0 to 1.8.0.
Adapts the use of PersistentPreRun, removed the CallParentPersistentPreRun and enabled cobra.EnableTraverseRunHooks - see Feature: allow running persistent run hooks of all parents spf13/cobra#2044

Release notes

Sourced from github.com/spf13/cobra's releases.

v1.8.0

✨ Features

Support usage as plugin for tools like kubectl by @nirs in spf13/cobra#2018 - this means that programs that utilize a "plugin-like" structure have much better support and usage (like for completions, command paths, etc.)

Move documentation sources to site/content by @umarcor in spf13/cobra#1428

Add 'one required flag' group by @marevers in spf13/cobra#1952 - this includes a new MarkFlagsOneRequired API for flags which can be used to mark a flag group as required and cause command failure if at least one is not used when invoked.

Customizable error message prefix by @5ouma in spf13/cobra#2023 - This adds the SetErrPrefix and ErrPrefix APIs on the Command struct to allow for setting a custom prefix for errors

feat: add getters for flag completions by @avirtopeanu-ionos in spf13/cobra#1943

Feature: allow running persistent run hooks of all parents by @vkhoroz in spf13/cobra#2044

Improve API to get flag completion function by @marckhouzam in spf13/cobra#2063

🐛 Bug fixes

Fix typo in fish completions by @twpayne in spf13/cobra#1945

Fix grammar: 'allows to' by @supertassu in spf13/cobra#1978

powershell: escape variable with curly brackets by @Luap99 in spf13/cobra#1960

Don't complete --help flag when flag parsing disabled by @marckhouzam in spf13/cobra#2061

Replace all non-alphanumerics in active help env var program prefix by @scop in spf13/cobra#1940

🔧 Maintenance

build(deps): bump golangci/golangci-lint-action from 3.4.0 to 3.5.0 by @dependabot in spf13/cobra#1971

build(deps): bump golangci/golangci-lint-action from 3.5.0 to 3.6.0 by @dependabot in spf13/cobra#1976

build(deps): bump golangci/golangci-lint-action from 3.6.0 to 3.7.0 by @dependabot in spf13/cobra#2021

build(deps): bump actions/setup-go from 3 to 4 by @dependabot in spf13/cobra#1934

build(deps): bump github.com/cpuguy83/go-md2man/v2 from 2.0.2 to 2.0.3 by @dependabot in spf13/cobra#2047

build(deps): bump actions/checkout from 3 to 4 by @dependabot in spf13/cobra#2028

command: temporarily disable G602 due to securego/gosec#1005 by @umarcor in spf13/cobra#2022

🧪 Testing & CI/CD

test: make fish_completions_test more robust by @branchvincent in spf13/cobra#1980

golangci: enable 'unused' and disable deprecated replaced by it by @umarcor in spf13/cobra#1983

cleanup: minor corrections to unit tests by @JunNishimura in spf13/cobra#2003

ci: test golang 1.21 by @nunoadrego in spf13/cobra#2024

Fix linter errors by @marckhouzam in spf13/cobra#2052

Add tests for flag completion registration by @marckhouzam in spf13/cobra#2053

✏️ Documentation

doc: fix typo, Deperecated -> Deprecated by @callthingsoff in spf13/cobra#2000

Add notes to doc about the execution condition of *PreRun and *PostRun functions by @haoming29 in spf13/cobra#2041

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

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

Commits

a0a6ae0 Improve API to get flag completion function (#2063)
890302a Support usage as plugin for tools like kubectl (#2018)
48cea5c build(deps): bump actions/checkout from 3 to 4 (#2028)
22953d8 Replace all non-alphanumerics in active help env var program prefix (#1940)
00b68a1 Add tests for flag completion registration (#2053)
b711e87 Don't complete --help flag when flag parsing disabled (#2061)
8b1eba4 Fix linter errors (#2052)
4cafa37 Allow running persistent run hooks of all parents (#2044)
5c962a2 build(deps): bump github.com/cpuguy83/go-md2man/v2 from 2.0.2 to 2.0.3 (#2047)
efe8fa3 build(deps): bump actions/setup-go from 3 to 4 (#1934)
Additional commits viewable in compare view

twz123 · 2023-11-07T09:14:21Z

Nice. There's also spf13/cobra#2018 which enables better plugin support. I think I remember that we had some workarounds for that that we might be able to drop now, too.

twz123 · 2023-11-08T08:20:57Z

I'm pondering if we can use that new functionality verbatim. IIUC the new upstream solution calls all the PersistentPreRun hooks, starting with the root until it reaches the actual command. We do have some places in which the PersistentPreRun of the actual command wants to perform some actions before the parent chain is called, and we did it in the reverse order, calling all the parents until we reached the root. This might not be a problem at all for most commands, but I think we need to give it some thought. Especially for the embedded kubectl command, which has special logic that bypasses all the PersistentPreRun handlers when plugins are called, and also performs log initialization before any PersistentPreRun handlers are invoked.

github-actions · 2023-12-08T23:04:00Z