Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.82 KB

README.md

File metadata and controls

37 lines (28 loc) · 1.82 KB
Raw

Getting started

make apiv2-init # from the root of the repo
docker compose exec graphql-api pip install cryoet_data_portal

# You can stop this after a few screenfuls of output if you don't need a full import.
docker compose exec graphql-api python3 scrape.py

After the above steps, browse the api at http://localhost:9009/graphql

How to make changes to the schema

# First, make any necessary changes to `apiv2/schema/schema.yaml`, then run this to generate new code & migrations and apply them:
cd apiv2
make update-schema

# Then, from the root of the repo, run:
cd ..
pre-commit run --all-files

# Then commit all changed files, *including* any new migrations!
git commit -am "chore: Updating schema to add X feature"

Creating an rdev stack

  1. Open a pull request
  2. Add a label called "stack" to the PR. This will trigger an action that creates an rdev stack. Once the stack has been created, the PR comment will be updated to reflect the URL you can use to access your rdev instance.
  3. NOTE!!: For now, all rdevs share a database. Fixing this is a TODO.

Updating staging/prod

  1. Merging a PR to main that has a conventional commit title of feat, fix, or breaking changes (chore doesn't count!) will trigger a release-please action that creates a new release candidate PR.
  2. Once the release PR has been created, another action gets triggered that builds a new staging docker image. This action also writes updated image sha's to staging/prod envs in .infra
  3. Once the new image build is complete, another action ensures that ArgoCD was able to successfully update staging.
  4. Merging the release PR means that the image SHA's in .infra/prod are updated in the main branch. ArgoCD will update prod to reflect the latest build.