docs: add v0.17 upgrade guide and update migration docs#831
Merged
alexluong merged 1 commit intofeat/refactor-docsfrom Apr 13, 2026
Merged
docs: add v0.17 upgrade guide and update migration docs#831alexluong merged 1 commit intofeat/refactor-docsfrom
alexluong merged 1 commit intofeat/refactor-docsfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
alexluong
force-pushed
the
docs/upgrade-v0.16.1
branch
from
162f455 to
d27dba4
Compare
alexluong
force-pushed
the
docs/upgrade-v0.16.1
branch
2 times, most recently
from
c98ff6c to
edf95cf
Compare
alexluong
force-pushed
the
docs/upgrade-v0.16.1
branch
from
edf95cf to
c9de2d8
Compare
alexluong
force-pushed
the
docs/upgrade-v0.16.1
branch
from
c9de2d8 to
38a7eab
Compare
alexluong
force-pushed
the
docs/upgrade-v0.16.1
branch
from
38a7eab to
79b7638
Compare
alexbouchardd
approved these changes
Apr 13, 2026
alexluong
force-pushed
the
docs/upgrade-v0.16.1
branch
from
79b7638 to
ee80c7a
Compare
alexluong
changed the title
alexluong
commented
Apr 13, 2026
Comment on lines
+24
to
+97
| ### Recommended deployment flow | ||
|
|
||
| The simplest approach is to always run migrations before starting the server: | ||
|
|
||
| ```bash | ||
| outpost migrate apply --yes | ||
| outpost serve | ||
| ``` | ||
|
|
||
| How you integrate this depends on your deployment setup. Below are some common patterns. | ||
|
|
||
| ### Docker Compose | ||
|
|
||
| Use a `migrate` service that runs before the main service: | ||
|
|
||
| ```yaml | ||
| services: | ||
| outpost-migrate: | ||
| image: hookdeck/outpost | ||
| command: ["migrate", "apply", "--yes"] | ||
| env_file: .env | ||
| depends_on: | ||
| redis: | ||
| condition: service_healthy | ||
|
|
||
| outpost: | ||
| image: hookdeck/outpost | ||
| command: ["serve"] | ||
| env_file: .env | ||
| depends_on: | ||
| outpost-migrate: | ||
| condition: service_completed_successfully | ||
| ``` | ||
|
|
||
| ### Kubernetes | ||
|
|
||
| Use an init container on the Outpost deployment: | ||
|
|
||
| ```yaml | ||
| spec: | ||
| initContainers: | ||
| - name: migrate | ||
| image: hookdeck/outpost | ||
| command: ["outpost", "migrate", "apply", "--yes"] | ||
| envFrom: | ||
| - secretRef: | ||
| name: outpost-config | ||
| containers: | ||
| - name: outpost | ||
| image: hookdeck/outpost | ||
| command: ["outpost", "serve"] | ||
| envFrom: | ||
| - secretRef: | ||
| name: outpost-config | ||
| ``` | ||
|
|
||
| Alternatively, run migrations as a separate Kubernetes Job before rolling out the new version. | ||
|
|
||
| ### CI/CD pipeline | ||
|
|
||
| Add a migration step before deploying the new version: | ||
|
|
||
| ```bash | ||
| # 1. Run migrations against production databases | ||
| docker run --rm --env-file .env \ | ||
| hookdeck/outpost migrate apply --yes | ||
|
|
||
| # 2. Deploy the new version | ||
| # (your deploy command here) | ||
| ``` | ||
|
|
||
| ### Other approaches | ||
|
|
||
| The examples above are recommendations — run migrations however fits your infrastructure. The only requirement is that `outpost migrate apply` completes before `outpost serve` starts. Some teams prefer a wrapper script in their entrypoint, others run it as a pre-deploy hook. Any approach works as long as migrations finish first. |
Collaborator
Author
There was a problem hiding this comment.
Would love some feedback here + whether this is important for migration.mdoc as well?
Contributor
There was a problem hiding this comment.
Seems worthwhile yes
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
alexluong
force-pushed
the
docs/upgrade-v0.16.1
branch
from
ee80c7a to
a730991
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
outpost migrateCLIUpgrade guide covers
outpost migrate apply --yesbeforeoutpost serve)Migration guide changes
cleanup,init --current,--allflag--yesinstead of--allTest plan
🤖 Generated with Claude Code