Skip to content

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

Open
Rafi-Microsoft wants to merge 3 commits intomainfrom
psl-addBicepVer
Open

docs: Add Bicep CLI (v0.33.0+) to local deployment prerequisites#574
Rafi-Microsoft wants to merge 3 commits intomainfrom
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 deployment guide of this Generic Solution Accelerator.

The infrastructure-as-code templates in this repository (under infra/) require a recent version of the Bicep CLI to compile and deploy successfully via azd up / az deployment. Without the minimum supported version, users running the deployment locally encounter cryptic compilation errors due to unsupported syntax/features in older Bicep releases.

Changes

  • Added a Bicep CLI (v0.33.0+) entry to the prerequisites list of the local deployment guide, following the exact format and style of the existing prerequisite entries (azd, Python, Node.js, etc.) in this repo.

Why

  • Aligns the local deployment guide with the actual minimum Bicep version required by the Bicep 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 (entry appears in the prerequisites list, link resolves to the official Microsoft Learn install page).
  • Confirmed the change is scoped to documentation only — no code, infrastructure, or configuration paths 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 deployment prerequisites so users provisioning this accelerator locally have the required Bicep version installed before running 'azd up' / 'az deployment'.

Work item: AB#42634
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds Bicep CLI as an explicit prerequisite in the local deployment instructions to prevent local azd/ARM/Bicep compilation failures caused by older Bicep versions when deploying the infra/ templates.

Changes:

  • Documented Bicep CLI 0.33.0+ as a required tool for “Option D: Local Environment” deployments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/DeploymentGuide.md Outdated
Copilot AI review requested due to automatic review settings May 6, 2026 16:57
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 2 out of 2 changed files in this pull request and generated no new comments.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants