Skip to content

Record release surface and distribution strategy - Issue #140#153

Merged
cdcavell merged 4 commits into
mainfrom
docs/issue-140-adr-release-decisions
May 24, 2026
Merged

Record release surface and distribution strategy - Issue #140#153
cdcavell merged 4 commits into
mainfrom
docs/issue-140-adr-release-decisions

Conversation

@cdcavell
Copy link
Copy Markdown
Owner

Summary

Adds ADR-0003 to record release-surface and distribution decisions needed before the future v1.0.0 release.

Changes

  • Documents the SemVer public surface for the template
  • Classifies MAJOR, MINOR, and PATCH changes for:
    • scaffolded project layout
    • template parameters and symbols
    • configuration keys and defaults
    • API route conventions
    • middleware ordering
    • container image tag conventions
    • internal class signatures
  • Records the intended stable distribution model as a NuGet-published dotnet template package
  • Records URL segment API versioning as the canonical default with X-API-Version as a secondary option
  • Records the Microsoft .NET SDK/runtime container image strategy
  • Records bounded metadata cross-linking guidance for related SSRN works
  • Adds README and DocFX links to the ADR where release behavior depends on it

Validation

  • dotnet tool run docfx -- docs/docfx.json
Restore complete (0.8s)

Build succeeded in 1.6s
warning: FailedToLoadAnalyzer: Failed to load .NET Analyzer. AnalyzerName: Microsoft.CodeAnalysis.Razor.Compiler, ErrorCode: ReferencesNewerCompiler, ReferencedCompilerVersion: 5.5.0.0
Loading project NetCoreApplicationTemplate/tests/ProjectTemplate.Web.Tests/ProjectTemplate.Web.Tests.csproj
Restore complete (0.9s)

Build succeeded in 1.6s
Processing ProjectTemplate.Infrastructure
Processing ProjectTemplate.Web
Processing ProjectTemplate.Web.Tests
Creating output...
Searching built-in plugins in directory 
Post processor ExtractSearchIndex loaded.
7 plug-in(s) loaded.
ExtractSearchIndex: UseMetadata = False, UseMetadataTitle = True
Building 5 file(s) in ResourceDocumentProcessor(ValidateResourceMetadata)...
Building 4 file(s) in TocDocumentProcessor(BuildTocDocument)...
Building 26 file(s) in ConceptualDocumentProcessor(BuildConceptualDocument=>ValidateConceptualDocumentMetadata)...
Building 119 file(s) in ManagedReferenceDocumentProcessor(BuildManagedReferenceDocument=>SplitClassPageToMemberLevel=>ValidateManagedReferenceDocumentMetadata=>ApplyOverwriteDocumentForMref=>FillReferenceInformation=>FillMetadata)...
Applying templates to 154 model(s)...
XRef map exported.
Extracting index data from 145 html files


Build succeeded with warning.

    1 warning(s)
    0 error(s)

Closes #140

@cdcavell cdcavell merged commit e32aa87 into main May 24, 2026
6 checks passed
@cdcavell cdcavell deleted the docs/issue-140-adr-release-decisions branch May 24, 2026 12:49
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.

decision/adr: record SemVer, template distribution, API versioning, container image, and cross-link strategy

1 participant