Doc: Add Run migration script instruction to Readme. #1090
Conversation
mtreacy002
force-pushed
the
readme-migration
branch
from
93ba2ac
to
38f3dfd
Compare
modify instructions to new and existing contributors
mtreacy002
force-pushed
the
readme-migration
branch
from
38f3dfd
to
cd43681
Compare
Codecov Report
@@ Coverage Diff @@
## bit #1090 +/- ##
=======================================
Coverage 94.50% 94.50%
=======================================
Files 39 39
Lines 2677 2677
=======================================
Hits 2530 2530
Misses 147 147 |
|
|
||
| This will attach the alembic version number on the repo (if any) to the local db. | ||
|
|
||
| * For existing contributors, run the following command: |
There was a problem hiding this comment.
Here existing contributors means whose DB is filled with some entries or those who run flask db upgrade in the past.
There was a problem hiding this comment.
Those whose db is filled with the previous version.
There was a problem hiding this comment.
@devkapilbansal and @epicadk , I might have to make it clearer here to distinct the 3 situations that might apply to contributors whose dealing with the migration (as I mentioned in this post). Please do share your opinion 😉 .
There was a problem hiding this comment.
Sure @mtreacy002
It would be good to make the documentation as clear as possible.
There was a problem hiding this comment.
Ok, @devkapilbansal , should I add those 3 steps on this PR or on #1038 ?
There was a problem hiding this comment.
I don't think that #1038 is required now. Since we are going to merge this branch in develop once completed
| @@ -271,8 +290,7 @@ The repository has the following permanent branches: | |||
|
|
|||
| * **develop** This contains the latest code. All the contributing PRs must be sent to this branch. When we want to release the next version of the app, this branch is merged into the `master` branch. This is the branch that is used in the deployed version of the app on Heroku. | |||
|
|
|||
| * **bit** This branch is for MS-backend version specific to [BridgeInTech](https://github.com/anitab-org/bridge-in-tech-backend) project. All the contributing PRs related to BIT-MS integration issue must be sent to this branch.<br> | |||
| **IMPORTANT!!** If this is your first time setting up the BridgeInTech project, please <b>DO NOT RUN</b> the MS backend server from this branch <b>BEFORE</b> you run the BIT backend server. Failing to do this will mess up the postgres db schemas used in BIT project. More instruction on setting up the BridgeInTech project can be found [here](https://github.com/anitab-org/bridge-in-tech-backend/blob/develop/.github/ENV_SETUP_INSTRUCTION.md). | |||
There was a problem hiding this comment.
Why this point is no more needed? Will not this disturb the Bridge in Tech project configuration?
There was a problem hiding this comment.
Nope because we are integrating so it doesn't make sense to have it any more.
There was a problem hiding this comment.
also, the current ms-backend-server from my repo is the one that contributors will continue using until full integration is completed in bit branch, but no need to have this explained in bit branch since they're not using this branch for BIT development atm.
devkapilbansal
added
the
Status: Needs Review
Description
Added instruction on how to run migration script to README.md when working on
bitbranch.Fixes #1089
Type of Change:
Code/Quality Assurance Only
How Has This Been Tested?
alembic_versionfolder.flask db stamp headto linked the latest alembic version on the repo to the local dbflask db upgrade, contributors would have MS only schema withoutalembic_versionfolder in their local_data.dbflask db upgradeto add the latest alembic version on the bit branch to the existing local_data.db.Checklist:
Code/Quality Assurance Only