-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
feat(confix): allow customization of migration plan #21202
Conversation
WalkthroughWalkthroughThe recent changes introduce a new feature in the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant PlanBuilder
participant ConfigLoader
User->>PlanBuilder: Request migration plan
PlanBuilder->>ConfigLoader: Load destination config
ConfigLoader-->>PlanBuilder: Return loaded config
PlanBuilder-->>User: Provide migration plan
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you target main? We can backport it all the way down to Confix
a4129da
to
f74ae7d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (2)
- tools/confix/CHANGELOG.md (1 hunks)
- tools/confix/migrations.go (2 hunks)
Additional context used
Path-based instructions (2)
tools/confix/CHANGELOG.md (1)
Pattern
**/*.md
: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"tools/confix/migrations.go (1)
Pattern
**/*.go
: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Additional comments not posted (4)
tools/confix/CHANGELOG.md (1)
34-37
: Changelog entry looks good.The entry is clear, correctly formatted, and provides a link to the relevant pull request.
tools/confix/migrations.go (3)
24-26
: Type definition is clear and useful.The
loadDestConfigFile
type provides a clear abstraction for loading configuration files, enhancing flexibility.
30-33
: Updates toMigrations
map improve consistency.Using
defaultPlanBuilder
for multiple versions centralizes the logic and enhances maintainability.
60-63
:defaultPlanBuilder
function is well-implemented.The function correctly uses the
loadDestConfigFile
type to load configurations, maintaining clarity and simplicity.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Co-authored-by: Hieu Vu <72878483+hieuvubk@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- tools/confix/migrations.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- tools/confix/migrations.go
Co-authored-by: Hieu Vu <72878483+hieuvubk@users.noreply.github.com> (cherry picked from commit 1d7f891)
Co-authored-by: Hieu Vu <72878483+hieuvubk@users.noreply.github.com> (cherry picked from commit 1d7f891) # Conflicts: # tools/confix/migrations.go
This has been included in Confix v0.1.2. Thanks @GAtom22! |
Description
Can happen that the application
app.toml
file has some differences with the Cosmos-SDK one. For those cases, performing the migrations using theconfig migrate ...
command results in an incorrect/incompleteapp.toml
.This PR introduces the changes to allow customization of the
PlanBuilder
function, specifically the function used to load and parse the TOML document of the destination version to migrate toCloses: #XXXX
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!
in the type prefix if API or client breaking changeCHANGELOG.md
Reviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
PlanBuilder
.