Table of Contents

Major Release Workflow

Assuming the transition is from version 4.1 to 4.2, and that the Stride source code has been updated to the corresponding .NET version, follow these steps. Note that some steps can be executed at a later stage if needed.

Before starting, create the master-4.1 branch from master: it keeps the documentation of 4.1 deployable once master documents 4.2.

  1. Update manual\install-and-update\requirements.md to reflect the new .NET version references
  2. Create ReleaseNotes\ReleaseNotes-4.2.md with the release notes for version 4.2
    • Use GitHub Release to generate a list of What's Changed, once the new tag is added, following the TeamCity build
    • Release notes of previous versions stay where they are, ReleaseNotes-4.1.md doesn't need any change
    • The release notes of all versions aren't versioned: they're built and deployed from master only (see unversioned in versions.json), so fixes to the release notes of older versions are made on master only
    • index.md, the list of the release notes, is generated by BuildDocs.ps1 from toc.yml
  3. Add name: 4.2 release notes with href: ReleaseNotes-4.2.md at the top of ReleaseNotes\toc.yml
  4. In en\docfx.json
    • Update TargetFramework in two locations to the current framework version being used. Ensure to test this step locally
  5. Edit versions.json
    • Under docs, add the new version at the top, i.e. { "url": "4.2", "name": "4.2 (beta)" }
    • Keep latest on the released version 4.1 for now
    • The highest version of versions.json is the one built from the branch
  6. For GitHub Actions deployment update *.yml files in the .github\workflows\ folder
    • dotnet-version: Update to the related .NET version
  7. Run Deploy Stride Docs version to Azure Web App from master with the staging slot, and check the staging environment
  8. ⚠️ Run it again with the production slot. The 4.2 folder is deployed next to the other versions, latest still serves 4.1, and the Stride Launcher can already load the release notes of 4.2
  9. Run Deploy Stride Docs site root to Azure Web App from master with the production slot, so that 4.2 (beta) appears in the version selector (pushing versions.json to master already deployed it to staging)

Once 4.2 is released:

  1. Edit versions.json: set latest to 4.2, and rename it from 4.2 (beta) to 4.2
  2. Run Deploy Stride Docs site root to Azure Web App from master with the production slot. /latest/ now serves 4.2, nothing needs to be rebuilt
  3. It might take up to 24 hours for the CDN to refresh. The best approach is to contact the core contributors and request a CDN reset

Deploying 4.1 later (from master-4.1) only replaces the 4.1 folder, it doesn't change versions.json, web.config or /latest/.

Other locations to update

  1. Modify contributors\engine\building-source-windows.md
    • Update SDK version references
    • Update Visual Studio version
  2. Modify contributors\engine\building-source-windows-other-ide.md
    • Update Build Tools path
  3. Modify contributors\engine\building-source-windows-visual-studio.md
    • Update Visual Studio version
  4. Modify manual\troubleshooting\stride-doesnt-run.md
    • Update SDK and .NET version references
    • Update Visual Studio version
  5. Modify manual\files-and-folders\distribute-a-game.md
    • Update SDK version references
  6. Modify manual\get-started\update-stride.md
    • Update Visual Studio version
  7. Modify includes\docs-prerequisites.md
    • Update SDK and .NET version references
    • Update Visual Studio version
Edit this page