Skip to content

Commit 01448af

Browse files
authored
Adding more detail for some instructions. (Azure#10049)
1 parent 729cd5d commit 01448af

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/release-checklist.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,26 @@
1616
1. Review history for changes to [bicepconfig.schema.json](https://github.com/Azure/bicep/commits/main/src/vscode-bicep/schemas/bicepconfig.schema.json). Raise an issue for any recently-added linter rules which do not have public documentation.
1717
1. (**end-of-month releases only**) Bump the version number by incrementing the minor version number in [this file](https://github.com/Azure/bicep/blob/main/version.json) (example [here](https://github.com/Azure/bicep/pull/9698))
1818
1. Run the Official Build (see [this README](https://msazure.visualstudio.com/One/_git/BicepMirror) for instructions).
19-
1. Get version number from official build and push a new tag to the Bicep repo. This should be of format `vXX.YY.ZZ` - e.g `v0.14.85`.
19+
1. Get version number from official build by looking at the artifacts and push a new tag to the Bicep repo. This should be of format `vXX.YY.ZZ` - e.g `v0.14.85`.
20+
1. In the Bicep repo, make sure you are on the main branch and on the latest commit.
21+
1. Run git tag v<new_release_number> (ex: git tag v0.15.31)
22+
1. Run git push origin v<new_release_number> (ex: git push origin v0.15.31)
2023
1. [Create a draft release](https://github.com/Azure/bicep/releases/new) for the new tag and set release title to the tag name. Use the "Save draft" button to save the changes without publishing it.
2124
1. Run `bicep/scripts/CreateReleaseNotes -FromTag <previous tag> -ToTag <new tag>` and set the output as the release description.
2225
1. Give the output of this script to a PM, and ask them to clean up the notes for the release.
2326
1. Once they have cleaned up the notes, copy + paste them into the draft notes, and hit "Save draft" again.
2427
1. Run `BicepMirror/scripts/UploadSignedReleaseArtifacts.ps1` to add official artifacts to the release.
25-
* `-WorkingDir` can be any empty temporary directory
28+
* `-WorkingDir` can be any empty temporary directory that you create
2629
* `-BuildId` is only needed if the latest official build is NOT the official build you are trying to release
2730
1. Validate VSCode extension and Bicep CLI manually on Windows, Mac & Linux:
2831
1. Download `vscode-bicep.vsix` from the draft release, and [Install it from VSIX](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix). Verify that you can open a Bicep file, that text is correctly colorized, and that error messages show up as expected.
2932
1. Download the appropriate Bicep executable for your platform (e.g. `bicep-linux-x64`). Verify you can invoke it with e.g. `bicep-linux-x64 --version`, and that it prints the expected output.
3033
1. Publish the release on GitHub.
3134
1. Upload copyleft dependency source to 3rd party disclosure site. See [instructions](https://msazure.visualstudio.com/One/_wiki/wikis/Azure%20Deployments%20Team%20Wiki/369910/Bicep-release-step-Upload-copyleft-source-to-3rd-party-disclosure-site).
3235
1. Upload vscode-bicep.VSIX to the VS marketplace [here](https://marketplace.visualstudio.com/manage).
36+
1. Click on the ... for Bicep, then Update, then upload the .vsix file. The site will verify it then the version number should be updated to the right one.
3337
1. Upload vs-bicep.VSIX to VS marketplace
38+
1. Click on the ... for Bicep for Visual Studio, then Edit. Once on the new page, upload the new vs-bicep.VSIX file at the top. This should update the Version number automatically for you. Verify that it does then scroll to the bottom and hit Save and Upload.
3439
1. Upload NuGet packages to nuget.org via `./scripts/PublishPackages.ps1`. (Make sure to include CLI packages. Easiest is to use the `__assets` directory created by the `UploadSignedReleaseArtifacts.ps1` script.)
3540
1. Update homebrew by going here [here](https://github.com/Azure/homebrew-bicep/actions/workflows/update-homebrew.yml) and clicking on `Run workflow`
3641
* A PR will be auto created by this action (example [here](https://github.com/Azure/homebrew-bicep/pull/40)). Approve and merge it.

0 commit comments

Comments
 (0)