feat: support .bicepparam parameter files for Bicep deployments#253
Conversation
There was a problem hiding this comment.
Pull request overview
Adds first-class support for Bicep-native .bicepparam parameter files in the MPF Bicep workflow by compiling them to ARM JSON parameters via bicep build-params when provided through --parametersFilePath, and updates samples/docs/tests accordingly (closes #12).
Changes:
- Detect
.bicepparamincmd/bicepCmd.goand compile to.parameters.jsonbefore running the deployment authorization checker. - Add a
.bicepparamsample and an e2e test exercisingbicep build-params+ deployment with the compiled parameters. - Update documentation to reflect
.bicepparamsupport and provide quickstart/flags examples.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
cmd/bicepCmd.go |
Adds .bicepparam detection and invokes bicep build-params to generate ARM JSON parameters prior to deployment. |
e2eTests/e2eBicep_test.go |
Adds a new e2e test using a .bicepparam file (compiled to JSON) with a simple storage account Bicep sample. |
samples/bicep/storage-account-simple-params.bicepparam |
Adds a Bicep-native parameters file sample referencing the storage account template. |
docs/known-issues-and-workarounds.MD |
Updates known-issues to reflect that .bicepparam is now supported. |
docs/installation-and-quickstart.md |
Adds quickstart examples showing .bicepparam usage (currently has formatting/command issues). |
docs/commandline-flags-and-env-variables.md |
Updates flag documentation to note .json and .bicepparam are supported. |
go.mod |
Bumps the Go toolchain version referenced by the module. |
maniSbindra
left a comment
There was a problem hiding this comment.
Review findings not yet raised by the automated review.
maniSbindra
left a comment
There was a problem hiding this comment.
Hi, a few changes in addition to the automated review requested. Thanks, Mani
|
Quick update on testing: I ran the new Result: PASS in about 120 seconds. The auto-compile path via the new Also worth flagging: the failing CI checks here look like the same upstream |
Detect .bicepparam extension on --parametersFilePath and automatically compile to ARM JSON format using 'bicep build-params' before deployment. Both .json and .bicepparam formats are now supported. - Add .bicepparam detection and compilation in bicepCmd.go - Add storage-account-simple-params.bicepparam sample file - Add TestBicepWithBicepparamFile e2e test - Update known-issues doc (no longer unsupported) - Add .bicepparam example to quickstart and flags docs Closes #12
- Bump Go 1.26.1 to 1.26.2 to fix stdlib vulnerabilities (govulncheck) - Fix errcheck: handle os.Remove return value in e2eBicep_test.go - Fix markdown: add missing blank lines before headings
…eanup, docs fixes, exact assertion count
871c8b3 to
a6e4e30
Compare
Detect .bicepparam extension on --parametersFilePath and automatically compile to ARM JSON format using 'bicep build-params' before deployment. Both .json and .bicepparam formats are now supported.
Closes #12