feat: tool for comparing different ignite versions #3718
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
component:ci
Ehsan-saradar
force-pushed
the
feat/auto-migdoc
branch
from
6d64b94 to
2cad27b
Compare
julienrbrt
reviewed
Apr 4, 2024
julienrbrt
reviewed
Apr 4, 2024
julienrbrt
reviewed
Apr 6, 2024
julienrbrt
previously approved these changes
Apr 17, 2024
salmad3
reviewed
Apr 17, 2024
salmad3
previously approved these changes
Apr 18, 2024
salmad3
approved these changes
Apr 19, 2024
Pantani
approved these changes
Apr 19, 2024
julienrbrt
pushed a commit
that referenced
this pull request
May 29, 2024
* Add gen-migdoc script * Fix gen-migdoc script * Add gen-mig-docs tool * Add exceptions and more test cases to migdoc * Add diff subtraction and cleanup * Minor improvements * Remove gen-migdoc bash script * Move exception files to different file * Change the diff subtraction algorithm * Clean up error handling * Add diff package * Add Subtract to diff package * Cleanup gen-mig-diffs * Fix bugs * Fix bugs * Add more test to subtract test cases * Update the subtract lines algorithm * go mod tidy * Add changelog * Fix lint errors * Fix bugs * Fix lint * make format * Fix cleanup * Update ignite/internal/tools/gen-mig-diffs/migdiff/gen.go Co-authored-by: Danilo Pantani <[email protected]> * Update ignite/internal/tools/gen-mig-diffs/migdiff/gen.go Co-authored-by: Danilo Pantani <[email protected]> * Fix lint * Use cliui instead of log package * add gen options * code clean * improve error log * reset and clean the repo before the checkout to avoid conflicts * use https for repo url * draft refactor * improve the logs * remove useless code * add pkg options * pass the context to the commands * add cache file * create Scaffold struct * fix wrong output * add the scaffold cache * fix folder search for diffs * improve the logs and comments * remove unused temp folder creation * fix binaries path * generate migration docs inside a doc template * format the markdown file * unhandled error * fix changelog * markdown breakline * add CI to generate migration docs for each release * skip diff if is empty * use script to gen mig file * fix link for the genesis file --------- Co-authored-by: Danilo Pantani <[email protected]> Co-authored-by: Danny <[email protected]> Co-authored-by: Pantani <Pantani>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
close #3699
Description
This PR implements a tool to scaffold two chains for different versions, compare them, and generate a concise version diff into a document file. This tool automates the comparison process by scaffolding a chain for each version and analyzing the differences to produce an informative report. After creating a new migration doc into the
docs/docs/06-migrationmigration folder with the name of the version (eg:v28.2.0.md)Sample of output (renamed to
.TXTonly for I can share here):v28.2.0.md.TXT
CO-AUTHOR: @Pantani