Skip to content

docs: Add Bicep CLI (v0.33.0+) to local deployment prerequisites#839

Merged
Roopan-Microsoft merged 6 commits into
mainfrom
psl-addBicepVer
May 7, 2026
Merged

docs: Add Bicep CLI (v0.33.0+) to local deployment prerequisites#839
Roopan-Microsoft merged 6 commits into
mainfrom
psl-addBicepVer

Conversation

@Rafi-Microsoft

Copy link
Copy Markdown
Contributor

Summary

This PR adds the Bicep CLI (v0.33.0+) as a prerequisite to the Local Environment deployment instructions in docs/DEPLOYMENT.md.

The infrastructure-as-code templates under infra/ (main.bicep and modules) require a recent version of the Bicep CLI to compile and deploy successfully via azd 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

  • Aligns the local deployment guide with the actual minimum Bicep version required by the templates in this repository.
  • Prevents first-run failures for new users provisioning the accelerator from a fresh local environment.
  • Brings this accelerator in line with the standard prerequisite set being rolled out across all CSA Generic Solution Accelerators (GSAs).

Type of Change

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change

Testing

  • Verified the Markdown renders correctly on GitHub (list item appears under Local Environment → tools, link resolves to the official Microsoft Learn install page).
  • Confirmed no other deployment doc (AZD_DEPLOYMENT.md, LocalDevelopmentSetup.md) is impacted; this change is scoped to the local deployment prerequisites list only.
  • N/A - no code paths or infrastructure templates are modified.

Checklist

  • My change follows the existing documentation style and formatting of the repository.
  • I have performed a self-review of my changes.
  • No new warnings, broken links, or formatting issues are introduced.
  • No code, configuration, or behavior changes are included in this PR (docs-only).

Related Work Item

  • AB#42634 — [ALL GSA's] - Add bicep version to the local deployment guide

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot AI review requested due to automatic review settings May 6, 2026 14:20

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

Comment thread README.md
Comment thread docs/DEPLOYMENT.md Outdated
Comment thread docs/AZD_DEPLOYMENT.md Outdated
Copilot AI review requested due to automatic review settings May 6, 2026 16:57
@Rafi-Microsoft

Copy link
Copy Markdown
Contributor Author

@copilot please re-review — addressed prior review comments in latest commits.

Copilot AI commented May 7, 2026

Copy link
Copy Markdown
Contributor

@copilot please re-review — addressed prior review comments in latest commits.

Re-reviewed the latest branch at 461008f. The azd version mismatch and the Bicep upgrade guidance look addressed in the docs. The only remaining gap I can still see from the earlier review is that the PR body still says the change is scoped to docs/DEPLOYMENT.md, while the branch also changes README.md, docs/AZD_DEPLOYMENT.md, and docs/AVMPostDeploymentGuide.md. No UI changes in this PR.

@Roopan-Microsoft Roopan-Microsoft merged commit 8f12a70 into main May 7, 2026
10 checks passed
@Roopan-Microsoft Roopan-Microsoft deleted the psl-addBicepVer branch May 7, 2026 17:21
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 2.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants