Verify the schema.rb integrity when running our CI #5009
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
In the past, we've run into situations where we commited a version of the schema.rb to version control which wasn't in sync with what you get when you create the database and run the migrations. This is something that might happen if you're working on different branches at the same time, run the migrations in all those branches, and then commit the current status of your database to your current branch. That will result in a schema file which contains the database changes done in all these branches instead of just the current one. Although this hasn't happened to us for years, we see it happening sometimes in other COSUL installations, and there's always a chance that we make a mistake and do it again. Until now, it wasn't a big deal because the installer sets up the database by running `db:create db:migrate`, which runs the migrations instead of using the `schema.rb` file. However, we're going to add multitenancy using the Aparment gem, and this gem uses the `schema.rb` file when creating a new schema for a new tenant [1]. If the `schema.rb` file contains changes that shouldn't be there, this will lead to different database schemas having different tables and/or columns and future migrations might crash on production when applied to some of these schemas. In other words, this mistake could now result in a disastrous situation. To help preventing that, we're adding a CI workflow that checks the current `schema.rb` file is in sync with the database migrations. [1] https://medium.com/infinite-monkeys/our-multi-tenancy-journey-with-postgres-schemas-and-apartment-6ecda151a21f#7e97
taitus
approved these changes
Oct 10, 2022
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.
References
Objectives
schema.rbfile to version controlRelease Notes
TODO: when we release a version including multitenancy, emphasize the convinience of running this task on your CI.