Skip to content
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.

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

cli-altsrc and cli-docs version drift and incompatibilities #2002

Closed
bartekpacia opened this issue Nov 2, 2024 · 0 comments · Fixed by #2004
Closed

cli-altsrc and cli-docs version drift and incompatibilities #2002

bartekpacia opened this issue Nov 2, 2024 · 0 comments · Fixed by #2004
Labels
area/v3 relates to / is being considered for v3 kind/bug describes or fixes a bug status/triage maintainers still need to look into this

Comments

@bartekpacia
Copy link
Member

bartekpacia commented Nov 2, 2024

What's the problem?

The latest urfave/cli (v3.0.0-alpha9.2), is not compatible with the latest urfave/cli-docs (v3.0.0-alpha5).

Attempting to build a project with those 2 dependencies results in:

~/projects/emu git:[master]
go build ./cmd/emu/
# github.com/urfave/cli-docs/v3
../../.cache/go/pkg/mod/github.com/urfave/cli-docs/v3@v3.0.0-alpha5/docs.go:273:16: flag.GetValue undefined (type cli.DocGenerationFlag has no field or method GetValue)
../../.cache/go/pkg/mod/github.com/urfave/cli-docs/v3@v3.0.0-alpha5/docs.go:400:21: flag.GetValue undefined (type cli.DocGenerationFlag has no field or method GetValue)

for a sample reproducer, see bartekpacia/emu#7

What's the larger problem?

There's no CI checks that prevent this kind of problem.

Ideally, nothing that breaks compatibility between the urfave/cli modules (cli, altsrc, and docs) should be mergeable (i.e. CI should be red), unless explicit approval from maintainers.

@bartekpacia bartekpacia added kind/bug describes or fixes a bug status/triage maintainers still need to look into this area/v3 relates to / is being considered for v3 labels Nov 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/v3 relates to / is being considered for v3 kind/bug describes or fixes a bug status/triage maintainers still need to look into this
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant