Skip to content

Release Instructions

James Kent edited this page Jan 28, 2026 · 1 revision

Step 1: check for updated/added environment variables

If there were additional variables in .env.example, you will need to fill in the appropriate information on staging and production by hand

Step 2: deploy master to staging

Deploy the current master to staging and test out all the pull requests that were added to during that release cycle. Some interfaces may be easier to test than others. (some like taking database backups; possibly may only be run on production)

Step 3: Iterate on code that does not behave as expected

If during your tests on staging, the code does not behave as expected, diagnose and add new pull requests (and deploy those to staging)

Step 4: Cut a release

Once you are happy with code on staging, create a release and mark it (e.g., 1.0.0)

Step 5: Deploy on Production

ssh into the production server and fetch the most recent tag, checkout the repo at the most recent tag. Ensure .env.example is up to date, Build both compose and neurostore, run any database migrations, and build the frontend (via npm). verify the deployment was successful by running a meta-analysis, check on whatever features you worked on during the release cycle.

Clone this wiki locally