Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 1.71 KB

RELEASES.md

File metadata and controls

25 lines (20 loc) · 1.71 KB
Raw

RELEASES

Releases are partially automated in BHIMA. This document is a checklist of things that need to be done before a release and the steps to creating a new release.

  1. Make a new branch called release-next that is based on upstream/master to do your release on. If one exists on upstream, remove it first.
  2. Run yarn to ensure you have the latest dependencies.
  3. (Optional, best practice) Test the latest migration script on a production database. (*)
  4. (Optional, best practice) Build the application in production mode with NODE_ENV=production yarn build.
  5. Determine the version number for the next version. (v1.X.Y)
  6. Create a new folder in the server/models/migrations/ directory to hold the migration file with the format v1.A.B-v1.X.Y where 1.A.B is the current version and v1.X.Y is the next version.
  7. Move the server/models/migrations/next/migrate.sql file to the directory created in the above step.
  8. Create a blank migrate.sql file in server/models/migrations/next/.
  9. Commit updated files (git commit ...)
  10. Run yarn release and follow the options.

(*) Optional, Best Practice: Test the latest database changes on a production database.

  1. Change your .env so the $DB_NAME variable is the correct one for a production database.
  2. Create your database migration script by running yarn migrate. This will create a file migration-$DB_NAME.sql.
  3. Catenate the latest release file into the output cat server/models/migrations/next/migrate.sql >> migration-$DB_NAME.sql.
  4. Build the migration script targetting your database. mysql $DB_NAME < migration-$DB_NAME.sql
  5. If no errors occur, remove the file migration-$DB_NAME.sql to prevent it from getting checked into SQL.