Skip to content

Update module github.com/spf13/cobra to v1 #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update module github.com/spf13/cobra to v1 #48

wants to merge 1 commit into from

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Feb 22, 2021 •
edited
Loading

This PR contains the following updates:

Package Change Age Confidence
github.com/spf13/cobra v0.0.7 -> v1.10.1 age confidence

Release Notes

spf13/cobra (github.com/spf13/cobra)

v1.10.1

Compare Source

🐛 Fix

v1.0.9 of pflags brought back ParseErrorsWhitelist and marked it as deprecated

Full Changelog: spf13/cobra@v1.10.0...v1.10.1

v1.10.0

Compare Source

What's Changed

🚨 Attention!

This version of pflag carried a breaking change: it renamed ParseErrorsWhitelist to ParseErrorsAllowlist which can break builds if both pflag and cobra are dependencies in your project.

  • If you use both pflag and cobra, upgrade pflagto 1.0.8 andcobrato1.10.0`
  • or use the newer, fixed version of pflag v1.0.9 which keeps the deprecated ParseErrorsWhitelist

More details can be found here: #​2303 (comment)

✨ Features
🐛 Fix
🪠 Testing
📝 Docs

New Contributors

Full Changelog: spf13/cobra@v1.9.1...v1.9.2

v1.9.1

Compare Source

🐛 Fixes

Full Changelog: spf13/cobra@v1.9.0...v1.9.1

v1.9.0

Compare Source

✨ Features

🐛 Fixes

🤖 Completions

🧪 Testing

✍🏼 Documentation

🔧 Dependency upgrades

Thank you to all of our amazing contributors and all the great work that's been going into the completions feature!!

👋🏼 New Contributors

Full Changelog: spf13/cobra@v1.8.1...v1.9.0

v1.8.1

Compare Source

✨ Features

  • Add env variable to suppress completion descriptions on create by @​scop in #​1938

🐛 Bug fixes

🔧 Maintenance

🧪 Testing & CI/CD

✏️ Documentation

New Contributors

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.8.0...v1.8.1

v1.8.0

Compare Source

✨ Features

  • Support usage as plugin for tools like kubectl by @​nirs in #​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 #​1428
  • Add 'one required flag' group by @​marevers in #​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 #​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 #​1943
  • Feature: allow running persistent run hooks of all parents by @​vkhoroz in #​2044
  • Improve API to get flag completion function by @​marckhouzam in #​2063

🐛 Bug fixes

🔧 Maintenance

🧪 Testing & CI/CD

✏️ Documentation

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
🐛 Bug fixes
🧪 Testing & CI/CD
🔧 Maintenance
✏️ Documentation

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

Compare Source

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 inits to be executed. Now, the check for groups has been moved to ExecuteC and provides more flexibility when working with grouped commands - @​marckhouzam (and shout out to @​aawsome, @​andig and @​KINGSABRI for a deep investigation into this! 👏🏼)

v1.6.0

Compare Source

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 🌠
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 🐛
Dependencies 🗳️
Testing 🤔
Docs ✏️
Misc 💭

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: spf13/cobra@v1.5.0...v1.6.0

v1.5.0

Compare Source

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 for a big value add: Active Help #​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 for this! #​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:

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 for further info!

Completions 👀

Documentation 📝

Testing & CI ⚙️

Beep boop, bot commits 🤖

Misc 💭

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

Compare Source

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.

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

Documentation 📝

  • Update Go Doc link and badge in README: #​1593
  • Fix to install command, now targets @latest: #​1576
  • Added MAINTAINERS file: #​1545

Other 💭

  • Bumped license year to 2022 in golden files: #​1575
  • Added Pixie to projects: #​1581
  • Updated labeler for new labeling scheme: #​1613 & syntax fix: #​1624

Shoutout to our awesome contributors helping to make this cobra release possible!!
@​spf13 @​marckhouzam @​johnSchnake @​jpmcb @​liggitt @​umarcor @​hiljusti @​marians @​shyim @​htroisi

v1.3.0

Compare Source

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
  • Fixed unbound variables in bash completions causing edge case errors #​1321
  • help completion formatting improvements & fixes #​1444
  • All completions now follow the help example: short desc are now capitalized and removes extra spacing from long description #​1455
  • Typo fixes in bash & zsh completions #​1459
  • Fixed mixed tab/spaces indentation in completion scripts. Now just 4 spaces #​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
  • Fix for invalid shell completions when using ~/.cobra.yaml. Log message Using config file: ~/.cobra.yaml now printed to stderr #​1510
  • Removes unnecessary trailing spaces from completion command descriptions #​1520
  • Option to hide default completion command #​1541
  • Remove __complete command for programs without subcommands #​1563

Generator changes ⚙️

Thanks to @​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
  • MatchAll allows combining several PositionalArgs to work in concert. This now allows for enabling composing PositionalArgs #​896

Bug Fixes 🐛

Testing 👀

  • Now testing golang 1.16.x and 1.17.x in CI #​1425
  • Fix for running diff test to ignore CR for windows #​949
  • Added helper functions and reduced code reproduction in args_test #​1426
  • Now using official golangci-lint github action #​1477

Security 🔏

  • Added GitHub dependabot #​1427
  • Now using Viper v1.10.0
    • There is a known CVE in an indirect dependency from viper: #​1538. This will be patched in a future release

Documentation 📝

  • Multiple projects added to the projects_using_cobra.md file: #​1377 #​1501 #​1454
  • Removed ToC from main readme file as it is now automagically displayed by GitHub #​1429
  • Documentation correct for when the --author flag is specified #​1009
  • shell_completions.md has an easier to use snippet for copying and pasting shell completions #​1372

Other 💭

  • Bump version of cpuguy83/go-md2man to v2.0.1 #​1460
  • Removed lesser typo from the GPL-2.0 license #​880
  • Fixed spelling errors #​1514

Thank you to all our amazing contributors ⭐🐍🚀

v1.2.1

Compare Source

Bug fixes
  • Quickfix for #​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: - The completions release

Compare Source

🌠 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 #​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 - #​1146
    • Note that projects providing completion through a different command name (say a command named "complete

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 was generated by Mend Renovate. View the repository job log.

@codecov
Copy link

codecov bot commented Feb 22, 2021 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 6.99%. Comparing base (115a4b5) to head (879fcb3).

❗ Current head 879fcb3 differs from pull request most recent head 04a7b19

Please upload reports for the commit 04a7b19 to get more accurate results.

Additional details and impacted files 
@@          Coverage Diff           @@
##           master     #48   +/-   ##
======================================
  Coverage    6.99%   6.99%           
======================================
  Files           8       8           
  Lines         143     143           
======================================
  Hits           10      10           
  Misses        133     133

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from a20dd29 to 3fc2993 Compare March 20, 2021 19:56
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from 3fc2993 to 0a6c9ad Compare October 19, 2021 02:15
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from 0a6c9ad to b7d91ad Compare March 7, 2022 13:04
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch 2 times, most recently from 0ed5bbe to c88467e Compare March 26, 2022 18:03
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from c88467e to ea92ecb Compare May 26, 2022 20:16
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from ea92ecb to 443926b Compare June 21, 2022 05:15
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from 443926b to afa563a Compare November 20, 2022 16:56
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from afa563a to 3894d2b Compare April 17, 2023 10:09
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from 3894d2b to 879fcb3 Compare November 4, 2023 21:42
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from 879fcb3 to 04a7b19 Compare June 15, 2024 00:18
@coderabbitai
Copy link

coderabbitai bot commented Jun 15, 2024 •
edited
Loading

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@renovate renovate bot changed the title Update module github.com/spf13/cobra to v1 Update module github.com/spf13/cobra to v1 - autoclosed Jan 20, 2025
@renovate renovate bot closed this Jan 20, 2025
@renovate renovate bot deleted the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch January 20, 2025 11:22
@renovate renovate bot changed the title Update module github.com/spf13/cobra to v1 - autoclosed Update module github.com/spf13/cobra to v1 Jan 20, 2025
@renovate renovate bot reopened this Jan 20, 2025
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from 0c8c47c to 04a7b19 Compare January 20, 2025 15:00
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from 04a7b19 to 3af5bf7 Compare January 29, 2025 22:44
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch 2 times, most recently from 88e0ea7 to b82efac Compare February 17, 2025 01:06
@renovate renovate bot changed the title Update module github.com/spf13/cobra to v1 Update module github.com/spf13/cobra to v1 - autoclosed Mar 27, 2025
@renovate renovate bot closed this Mar 27, 2025
@renovate renovate bot changed the title Update module github.com/spf13/cobra to v1 - autoclosed Update module github.com/spf13/cobra to v1 Mar 27, 2025
@renovate renovate bot reopened this Mar 27, 2025
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from 7a36cd2 to b82efac Compare March 27, 2025 18:35
@renovate renovate bot changed the title Update module github.com/spf13/cobra to v1 Update module github.com/spf13/cobra to v1 - autoclosed Jun 30, 2025
@renovate renovate bot closed this Jun 30, 2025
@renovate renovate bot changed the title Update module github.com/spf13/cobra to v1 - autoclosed Update module github.com/spf13/cobra to v1 Jul 1, 2025
@renovate renovate bot reopened this Jul 1, 2025
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from 07637c3 to b82efac Compare July 1, 2025 04:57
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from b82efac to d23ce1a Compare July 17, 2025 09:40
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from d23ce1a to 622f7d1 Compare September 6, 2025 19:39
@renovate renovate bot force-pushed the renovate/github.amrom.workers.dev-spf13-cobra-1.x branch from 622f7d1 to 4049cdf Compare September 6, 2025 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant