Skip to content

Fix documentation for custom version table implementation and metadata interface#2219

Closed
jzabroski with Copilot wants to merge 1 commit into
fix-custom-table-version-docsfrom
copilot/sub-pr-2218
Closed

Fix documentation for custom version table implementation and metadata interface#2219
jzabroski with Copilot wants to merge 1 commit into
fix-custom-table-version-docsfrom
copilot/sub-pr-2218

Conversation

Copilot AI commented Jan 8, 2026

Copy link
Copy Markdown
Contributor

Addressed documentation issues in the custom version table configuration section per issue #2217.

Changes

  • Property descriptions: Corrected IVersionTableMetaData property descriptions to accurately reflect that columns store information for each migration, not just the last one
  • Implementation examples: Added comprehensive examples showing both direct IVersionTableMetaData implementation and inheritance from DefaultVersionTableMetaData with proper constructor patterns
  • Registration patterns: Documented the difference between .WithVersionTable() for direct implementations and .AddScoped<IVersionTableMetaData, T>() for DI-based registrations

Examples Added

Direct implementation:

[VersionTableMetaData]
public class CustomVersionTable : IVersionTableMetaData
{
    public string TableName => "CustomVersionInfo";
    // ... other properties
}

services.ConfigureRunner(rb => rb.WithVersionTable(new CustomVersionTable()))

Inheritance pattern:

[VersionTableMetaData]
public class CustomVersionTable : DefaultVersionTableMetaData
{
    public CustomVersionTable(IConventionSet conventionSet, IOptions<RunnerOptions> runnerOptions) 
        : base(conventionSet, runnerOptions) { }
    
    public override string TableName => "CustomVersionInfo";
    public override string SchemaName => "migrations";
}

services.AddScoped<IVersionTableMetaData, CustomVersionTable>();

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Fix documentation for custom version table implementation Fix documentation for custom version table implementation and metadata interface Jan 8, 2026
Copilot AI requested a review from jzabroski January 8, 2026 18:55
@github-actions

github-actions Bot commented Jan 8, 2026

Copy link
Copy Markdown

Test Results

    2 files  ±0      2 suites  ±0   37s ⏱️ -2s
5 396 tests ±0  5 064 ✅ ±0  332 💤 ±0  0 ❌ ±0 
5 877 runs  ±0  5 281 ✅ ±0  596 💤 ±0  0 ❌ ±0 

Results for commit 2218071. ± Comparison against base commit f85b6e7.

@jzabroski
jzabroski deleted the branch fix-custom-table-version-docs January 15, 2026 21:55
@jzabroski jzabroski closed this Jan 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants