[ENT] Versioned Migration via Atlas #1887
Merged
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.
Description of the PR
This adds the ability to run versioned migration for ENT whenever the schema changes.
This follows the recommendation provided in: https://entgo.io/docs/versioned-migrations/#quick-guide
Checks have been added to the CI to check that the migration diff has been generated and a linter has been run via atlas.
Note: For production use cases auto migration should be disabled and atlas should be used to apply the initial migration!!
closes #1513
Example usage:
make generate
which will also run atlas (needs to have docker running). This will generate the migration plan inpkg/assembler/backends/ent/migrate/migrations
--url
must be set to the running production database--baseline
specified the baseline that is currently applied to the running database (if started without atlas)Note: A new baseline can be created from the production server by running:
After successful execution, you will see the following message:
PR Checklist
-s
flag togit commit
.make generate
has been runmake generate
has been runcollectsub
protobuf has been changed,make proto
has been run