docs: Add Bicep CLI (v0.33.0+) to local deployment prerequisites#839
Open
Rafi-Microsoft wants to merge 6 commits intomainfrom
Open
docs: Add Bicep CLI (v0.33.0+) to local deployment prerequisites#839Rafi-Microsoft wants to merge 6 commits intomainfrom
Rafi-Microsoft wants to merge 6 commits intomainfrom
Conversation
Adds Bicep CLI (v0.33.0+) to the Local Environment prerequisites in docs/DEPLOYMENT.md so users running 'azd up' locally have the required Bicep version installed before provisioning the infrastructure templates. Work item: AB#42634
Rafi-Microsoft
requested review from
Avijit-Microsoft,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft,
aniaroramsft,
malrose07,
nchandhi and
toherman-msft
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the local deployment documentation to include the Bicep CLI as an explicit prerequisite, helping prevent local azd/Bicep compilation failures caused by outdated tooling.
Changes:
- Added Bicep CLI (v0.33.0+) to the “Deploy in your local Environment → Local Environment” prerequisites list in
docs/DEPLOYMENT.md.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
75
to
79
| > **Note:** This solution accelerator requires **Azure Developer CLI (azd) version 1.18.0 or higher**. Please ensure you have the latest version installed before proceeding with deployment. [Download azd here](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd). | ||
|
|
||
| > **Note:** This solution accelerator also requires **Bicep CLI version 0.33.0 or higher** for compiling infrastructure templates. [Install Bicep](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install). | ||
|
|
||
| [Click here to launch the deployment guide](./docs/DEPLOYMENT.md) |
| @@ -106,6 +106,7 @@ If you're not using one of the above options for opening the project, then you'l | |||
| 1. Make sure the following tools are installed: | |||
| - [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.5) <small>(v7.0+)</small> - available for Windows, macOS, and Linux. | |||
| - [Azure Developer CLI (azd)](https://aka.ms/install-azd) <small>(v1.15.0+)</small> | |||
Comment on lines
+39
to
+41
| # Install via Azure CLI | ||
| az bicep install | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds the Bicep CLI (
v0.33.0+) as a prerequisite to the Local Environment deployment instructions indocs/DEPLOYMENT.md.The infrastructure-as-code templates under
infra/(main.bicepand modules) require a recent version of the Bicep CLI to compile and deploy successfully viaazd up/az deployment. Without this version, users running the deployment locally hit cryptic compilation errors due to unsupported syntax/features in older Bicep releases.Changes
docs/DEPLOYMENT.md→ Added Bicep CLI (v0.33.0+) entry under the Deploy in your local Environment → Local Environment → tools list, following the exact format used for the existing prerequisites (PowerShell, azd, Python, Node.js, Docker, Git).Why
Type of Change
Testing
AZD_DEPLOYMENT.md,LocalDevelopmentSetup.md) is impacted; this change is scoped to the local deployment prerequisites list only.Checklist
Related Work Item
[ALL GSA's] - Add bicep version to the local deployment guide