Skip to content

Release Steps

Jump to bottom
Konstantin Lepeshenkov edited this page Nov 23, 2022 · 3 revisions
  1. Change version number in the following files:

  1. In durablefunctionsmonitor.react folder run npm run build-and-copy, to make sure that all the latest UI artifacts are committed into the repo.

  2. Add a meaningful changelog entry to durablefunctionsmonitor-vscodeext/CHANGELOG.md. We need to do it at this early stage because this file needs to be packaged into the VSIX-file.

  3. Commit the above changes with a meaningful comment, e.g. version X.Y.

  4. Wait until the build succeeds. The build artifacts will contain a folder with deployable backend binaries, a NUPKG-file (the backend packaged into a NuGet package) and a VSIX-file (the compiled and packaged VsCode extension).

  5. Make sure the build artifacts work. E.g. by deploying it to a test Function App instance. Or by installing the produced VSIX-file locally into your VsCode.

  6. Push the newly produced NuGet package to nuget.org. Normally we do that with a separate release pipeline.

  7. Update the NuGet package readme. This needs to be done manually for each newly pushed version via nuget.org portal, because there is (was) no way to pack that readme file/link to it directly into the NUPKG file. The readme markdown file itself is here, just need to specify a raw link to it on nuget.org's package management page.

  8. After the package is published to NuGet.org, bump up the referenced durablefunctionsmonitor.dotnetbackend package version in custom-backends/mssql/Dfm.MsSql.csproj and custom-backends/netherite/Dfm.Netherite.csproj.

    When committing this change, also give it a meaningful comment, e.g. version X.Y.

    We're doing this after pushing the package to NuGet.org specifically to ensure that nobody tries to run these custom backends while the package is not there yet.

  9. Wait until the build succeeds again.

  10. Push the newly produced VSIX-file (found in the artifacts) to VsCode Marketplace. Make sure you use the most recent (from step 9) build for that.

  11. Install the fresh version of VsCode extension from marketplace into your VsCode instance and make sure everything works. Preferably check that you can still connect to a 'classic' TaskHub (handled by the default Storage Durability Provider) and to a SQL-backed TaskHub (handled by a SQL Durability Provider).

  12. Push the newly produced Docker image to hub.docker.com. Make sure you use the correct image tag that matches the new version, e.g. X.Y. Normally we do that with a separate release pipeline.

  13. Bump up the durablefunctionsmonitor's image tag in durablefunctionsmonitor.dotnetbackend/dfm-aks-deployment.yaml.

  14. Create a new GitHub Release. Specify the meaningful source code tag, that matches the version, e.g. vX.Y. Copy the markdown from one of previous releases, describe the new features/bugfixes in the changelog part and change version numbers in all the links.

  15. Update all the READMEs and the Wiki, when necessary.

  16. Spread the news on social media.

Clone this wiki locally