Skip to content

Use migration ID as scaffolded migration type name #37841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AndriySvyryd merged 5 commits into from
Mar 4, 2026
Merged

Use migration ID as scaffolded migration type name #37841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c022c8b
Initial plan
Copilot Mar 4, 2026
f3c4724
Append timestamp to scaffolded migration type names
Copilot Mar 4, 2026
7317eff
Use migration ID directly as the type name
Copilot Mar 4, 2026
035f635
Fix test baselines for migration ID-based type names
Copilot Mar 4, 2026
9c8f56a
Update test/EFCore.Design.Tests/Migrations/Design/MigrationScaffolder…
AndriySvyryd Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/EFCore.Design/Migrations/Design/MigrationsScaffolder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,13 +174,13 @@ public virtual ScaffoldedMigration ScaffoldMigration(
var codeGenerator = Dependencies.MigrationsCodeGeneratorSelector.Select(language);
var migrationCode = codeGenerator.GenerateMigration(
migrationNamespace,
migrationName,
migrationId,
upOperations,
Comment thread
AndriySvyryd marked this conversation as resolved.
downOperations);
var migrationMetadataCode = codeGenerator.GenerateMetadata(
migrationNamespace,
_contextType,
migrationName,
migrationId,
migrationId,
Dependencies.Model);
var modelSnapshotCode = codeGenerator.GenerateSnapshot(
Expand Down
5 changes: 3 additions & 2 deletions test/EFCore.Design.Tests/Design/OperationExecutorTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ private void TestAddMigrationPositive(
string processedOutputDir,
string productVersion)
{
var migrationTypeName = $"_11112233445566_{processedMigrationName}";
using var tempPath = new TempDirectory();
var resultHandler = ExecuteAddMigration(tempPath, migrationName, Path.Combine(tempPath, outputDir), productVersion);

Expand Down Expand Up @@ -124,7 +125,7 @@ namespace My.Gnomespace.Data
{
[DbContext(typeof(OperationExecutorTest.GnomeContext))]
[Migration("11112233445566_{{migrationName}}")]
partial class {{processedMigrationName}}
partial class {{migrationTypeName}}
{
/// <inheritdoc />
protected override void BuildTargetModel(ModelBuilder modelBuilder)
Expand All @@ -147,7 +148,7 @@ protected override void BuildTargetModel(ModelBuilder modelBuilder)
namespace My.Gnomespace.Data
{
/// <inheritdoc />
public partial class {{processedMigrationName}} : Migration
public partial class {{migrationTypeName}} : Migration
{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
Expand Down
12 changes: 12 additions & 0 deletions test/EFCore.Design.Tests/Migrations/Design/MigrationScaffolderTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,18 @@ public void ScaffoldMigration_can_override_namespace()
Assert.Equal("OverrideNamespace.OverrideSubNamespace", migration.SnapshotSubnamespace);
}

[ConditionalFact]
public void ScaffoldMigration_uses_migration_id_as_type_name()
{
var scaffolder = CreateMigrationScaffolder<ContextWithSnapshot>();

var migration = scaffolder.ScaffoldMigration("DateTime", "WebApplication1");

Assert.Contains($"public partial class _{migration.MigrationId} : Migration", migration.MigrationCode);
Assert.Contains($"partial class _{migration.MigrationId}", migration.MetadataCode);
Assert.Contains($"[Migration(\"{migration.MigrationId}\")]", migration.MetadataCode);
}

private IMigrationsScaffolder CreateMigrationScaffolder<TContext>()
where TContext : DbContext, new()
{
Expand Down
4 changes: 2 additions & 2 deletions test/EFCore.SqlServer.HierarchyId.Tests/MigrationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ namespace Microsoft.EntityFrameworkCore.SqlServer;

public class MigrationTests
{
private delegate string MigrationCodeGetter(string migrationName, string rootNamespace);
private delegate string MigrationCodeGetter(string migrationId, string rootNamespace);

private delegate string SnapshotCodeGetter(string rootNamespace, string migrationId);

Expand Down Expand Up @@ -56,7 +56,7 @@ private static void ValidateMigrationAndSnapshotCode(
.GetRequiredService<IMigrationsScaffolder>()
.ScaffoldMigration(migrationName, rootNamespace);

var expectedMigration = migrationCodeGetter(migrationName, rootNamespace);
var expectedMigration = migrationCodeGetter(migration.MigrationId, rootNamespace);
var expectedSnapshot = snapshotCodeGetter(rootNamespace, migration.MigrationId);

Assert.Equal(expectedMigration, migration.MigrationCode, ignoreLineEndingDifferences: true);
Expand Down
4 changes: 2 additions & 2 deletions test/EFCore.SqlServer.HierarchyId.Tests/TestModels/Migrations/AnonymousArraySeedContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
});
}

public override string GetExpectedMigrationCode(string migrationName, string rootNamespace)
public override string GetExpectedMigrationCode(string migrationId, string rootNamespace)
=> $@"using Microsoft.EntityFrameworkCore.Migrations;
using Microsoft.SqlServer.Types;

Expand All @@ -52,7 +52,7 @@ public override string GetExpectedMigrationCode(string migrationName, string roo
namespace {rootNamespace}.Migrations
{{
/// <inheritdoc />
public partial class {migrationName} : Migration
public partial class _{migrationId} : Migration
{{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
Expand Down
2 changes: 1 addition & 1 deletion test/EFCore.SqlServer.HierarchyId.Tests/TestModels/Migrations/MigrationContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ protected void RemoveVariableModelAnnotations(ModelBuilder modelBuilder)
model.RemoveAnnotation(SqlServerAnnotationNames.ValueGenerationStrategy);
}

public abstract string GetExpectedMigrationCode(string migrationName, string rootNamespace);
public abstract string GetExpectedMigrationCode(string migrationId, string rootNamespace);
public abstract string GetExpectedSnapshotCode(string rootNamespace, string migrationId);
}
4 changes: 2 additions & 2 deletions test/EFCore.SqlServer.HierarchyId.Tests/TestModels/Migrations/TypedArraySeedContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
});
}

public override string GetExpectedMigrationCode(string migrationName, string rootNamespace)
public override string GetExpectedMigrationCode(string migrationId, string rootNamespace)
=> $@"using Microsoft.EntityFrameworkCore.Migrations;
using Microsoft.SqlServer.Types;

Expand All @@ -52,7 +52,7 @@ public override string GetExpectedMigrationCode(string migrationName, string roo
namespace {rootNamespace}.Migrations
{{
/// <inheritdoc />
public partial class {migrationName} : Migration
public partial class _{migrationId} : Migration
{{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
Expand Down
Loading