DEV: Docker Entrypoint for Alembic Upgrade

[zdomke]

Description

Add an entrypoint to Dockerfile.dev to run alembic upgrade head automatically before when starting docker containers. We may only want to upgrade automatically for dev environments, so we may choose to avoid this if we have a separate prod docker file.

One of the benefits to using alembic here is that if alembic's current iteration is already on the head, then nothing happens.

Motivation

We were tired of running alembic upgrade head when removing/building volumes. Even more tired of forgetting to run that command.

Pre-merge checklist

• Code works interactively
• Code contains descriptive docstrings
• New/changed functions and methods are covered in the test suite where possible
• Test suite passes locally
• Test suite passes on GitHub Actions

[shilorigins]

This works for me, thanks!

[shilorigins]

Can you also remove the alembic upgrade head command from the installation docs in this PR?

[zdomke]

Can you also remove the alembic upgrade head command from the installation docs in this PR?

So I looked through all of the documentation for any references to alembic upgrade head and I'm mostly only seeing it come up in a couple of scenarios:

1. As a reference for alembic commands that may be useful to developers (such as migrations.md)
2. In reference to the "Local Development" installation

I think these both have their problems, but the way they use the command is kinda correct.

We should consider a documentation overhaul (#34) at some point because there's a lot of bad documentation in here. For example, we probably don't need a quick reference for the Alembic commands in our docs. We could possibly link to existing Alembic documentation instead. And as for the "Local Development", the docs consistently reference a script that doesn't exist called seed_pvs.

TL;DR: I think I'm going to leave the docs references to alembic upgrade head because I can't find any that are made incorrect by this PR.

[shilorigins]

@zdomke A wrinkle for automatic updates? I'm getting this error in squirrel-api when trying to run off of a dev branch:

squirrel-api  | INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
squirrel-api  | INFO  [alembic.runtime.migration] Will assume transactional DDL.
squirrel-api  | ERROR [alembic.util.messaging] Multiple head revisions are present for given argument 'head'; please specify a specific target revision, '<branchname>@head' to narrow to a specific head, or 'heads' for all heads
squirrel-api  | FAILED: Multiple head revisions are present for given argument 'head'; please specify a specific target revision, '<branchname>@head' to narrow to a specific head, or 'heads' for all heads