Skip to content

docs: improve migration guide v3#2093

Merged
dearchap merged 9 commits intourfave:mainfrom
ldez:feat/improve-migration-guide
Apr 7, 2025
Merged

docs: improve migration guide v3#2093
dearchap merged 9 commits intourfave:mainfrom
ldez:feat/improve-migration-guide

Conversation

@ldez
Copy link
Copy Markdown
Contributor

@ldez ldez commented Apr 6, 2025

What type of PR is this?

  • documentation

What this PR does / why we need it:

  • Improves migration guide v2->v3
    • improve headings
    • add authors
    • add BashCompletion/ShellCompletion
    • fix chain example
    • fix altsrc example
    • fix FilePath and EnvVars examples

Add "Migrating to v3" page to v2 documentation.

Which issue(s) this PR fixes:

No related issue.

Special notes for your reviewer:

Migrate v2 to v3 page

Screenshot 2025-04-07 at 00-41-53 Migrate v2 to v3 - urfave_cli

Release Notes

NONE

@ldez ldez requested a review from a team as a code owner April 6, 2025 22:04
@ldez ldez force-pushed the feat/improve-migration-guide branch from 50eae36 to c2c23fa Compare April 6, 2025 22:35
@ldez ldez force-pushed the feat/improve-migration-guide branch from b16354c to d9cf513 Compare April 6, 2025 22:38
@ldez ldez force-pushed the feat/improve-migration-guide branch from b1818c6 to 28f46d1 Compare April 6, 2025 22:48
@ldez
Copy link
Copy Markdown
Contributor Author

ldez commented Apr 6, 2025

Note, with github.com/urfave/cli-altsrc/v3@v3.0.0-alpha1, the example about precedence is wrong because altsrc.XXX is a ValueSourceChain and not a ValueSource.

But the implementation of github.com/urfave/cli-altsrc/v3 has been fixed by urfave/cli-altsrc#21

@ldez ldez force-pushed the feat/improve-migration-guide branch from f0f9669 to 7d0e69e Compare April 6, 2025 23:48
Copy link
Copy Markdown
Member

@Juneezee Juneezee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 😊 !

@dearchap dearchap merged commit efab65a into urfave:main Apr 7, 2025
10 checks passed
@ldez ldez deleted the feat/improve-migration-guide branch April 7, 2025 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants