Tasks to complete before releasing Steeltoe 4.0.0

[TimHess]

Beta 1

• Review/update all Steeltoe package metadata #1460
• Rename package Steeltoe.Logging.DynamicLogger to Steeltoe.Logging.DynamicConsole #1466
• Review SourceLink and pdb configurations (embed pdb files?) #1461
• Pin dependency versions (keep wildcard at patch level, update comments) #1470
• Update Documentation for v4 Documentation#317
• Update readme #1463
• Update Initializr InitializrConfig#121
• Update JSON Schema (by running the tool at https://github.com/SteeltoeOSS/Schema and updating MainSite), update appsettings references in Samples
• Run integration tests

Release Candidate 1

• Update samples based on guidelines Samples#319
• Address Sonar warnings in cibuild #1472
• Review flaky tests #1469

Final release

• Finalize Shipped/Unshipped API text files (scripts at https://github.com/dotnet/aspire/tree/release/9.0/eng/apicompat and https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/blob/8.4.0/Tools/mark-shipped.ps1)

• Review/align branching strategies between Steeltoe repos

  • Search/replace branch names in Samples and Documentation
  • Tag branches in samples/docs/schema after release

• Provide user guidance about merged packages #1242 and Make use of nuget depreciation warnings #1241

[bart-vmware]

I'd like to suggest the following branch names:

• "main" in Steeltoe/Samples/Documentation/MainSite: ongoing development
• "release/2.x" and "release/3.x" in Steeltoe: the latest stable release, available for hotfixes (earlier releases can be identified by tag)
• "2.x" and "3.x" in Samples: source for linking to from documentation
• "release/latest" in Documentation/MainSite: what's deployed to steeltoe.io production ("main" deployed to staging dev.steeltoe.io)

Cross-links in main branches remain problematic. They need to be updated each time a major release ships.

Once these changes have been applied, we should run a tool like https://www.screamingfrog.co.uk/seo-spider/tutorials/broken-link-checker/ to discover broken links.

[TimHess]

We'll have to make some changes to the release process for Documentation/MainSite to account for the new strategy (along with potentially merging the documentation back into mainsite while updating docfx), but I agree with all of the above.