[docs] Document AddEFMigrations and PublishAsMigrationBundle with publishContainer option#774
Merged
IEvangelist merged 2 commits intorelease/13.3from Apr 30, 2026
Conversation
…ishContainer Document the AddEFMigrations AppHost API and the new publishContainer: true option for PublishAsMigrationBundle introduced in microsoft/aspire#16289. - Add 'Automated EF migrations with AddEFMigrations' section covering: - Package installation - AppHost configuration via AddEFMigrations - RunDatabaseUpdateOnStart for local run mode - PublishAsMigrationScript and PublishAsMigrationBundle for publish pipeline - New publishContainer: true option to wrap bundle in a container image - Per-environment configuration (ACA Job, Docker Compose, Kubernetes) - Artifact-only (no container) usage pattern Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
16 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for Aspire’s first-class EF Core migrations AppHost API (AddEFMigrations), including local startup migration execution and publish-time generation of migration scripts/bundles (including bundling as a container image via publishContainer: true).
Changes:
- Expanded the page description to cover startup migrations and containerized migration bundles.
- Added a new “Automated EF migrations with
AddEFMigrations” section covering setup, local run behavior, publish artifacts, and per-environment deployment patterns.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AndriySvyryd
approved these changes
Apr 29, 2026
Agent-Logs-Url: https://github.com/microsoft/aspire.dev/sessions/e98f02d1-22c1-45c0-bac2-d26789008422 Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
AndriySvyryd
approved these changes
Apr 29, 2026
IEvangelist
deleted the
docs/ef-migrations-bundle-container-6b75669525f4acda
branch
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
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.
Documents changes from microsoft/aspire#16289
@AndriySvyrydTargeting
main—release/13.3does not exist onmicrosoft/aspire.dev(onlymainis present), so falling back tomainas the effective target branch.Why this PR is needed
PR microsoft/aspire#16289 added the ability to publish an EF Core migration bundle as a container image by passing
publishContainer: truetoPublishAsMigrationBundle(). The existing EF Core migrations documentation on aspire.dev only covers the manual worker-service approach and contains no coverage of theAddEFMigrationsAppHost API,RunDatabaseUpdateOnStart,PublishAsMigrationScript, orPublishAsMigrationBundle. This PR fills that gap.What was changed
Added a new top-level section "Automated EF migrations with
AddEFMigrations" tosrc/frontend/src/content/docs/integrations/databases/efcore/migrations.mdxcovering:Aspire.Hosting.EntityFrameworkCore)AddEFMigrationsRunDatabaseUpdateOnStart()for local run mode, with resource state tablePublishAsMigrationScript()andPublishAsMigrationBundle()for the publish pipelinepublishContainer: true— wraps the bundle in a container image that any compute environment can deploy like a regular containerFiles modified
src/frontend/src/content/docs/integrations/databases/efcore/migrations.mdx— updated (146 lines added)This draft PR needs human review before merging.