Refine docs command configuration and error handling - #20269
Merged
Jared Holgate (jaredfholgate) merged 2 commits intoSep 8, 2026
Merged
Conversation
Keep templates in bicepconfig while allowing invocation-specific custom values, align diagnostics and failures with existing CLI behavior, consolidate command registration, and remove redundant direct globbing references. Co-authored-by: Anthony Martin <38542602+anthony-c-martin@users.noreply.github.com> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 008f3689-f779-43d5-a0ed-efffca450f72
Contributor
|
Test this change out locally with the following install scripts (Action run 34277737550) VSCode
Azure CLI
|
Jared Holgate (jaredfholgate)
marked this pull request as ready for review
September 4, 2026 18:28
Retain the direct Microsoft.Extensions.FileSystemGlobbing reference because Bicep.Core uses it directly instead of relying on another package's transitive dependency graph. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 008f3689-f779-43d5-a0ed-efffca450f72
Anthony Martin (anthony-c-martin)
approved these changes
Sep 8, 2026
Anthony Martin (anthony-c-martin)
left a comment
Member
There was a problem hiding this comment.
Looks great, thank you!
Jared Holgate (jaredfholgate)
deleted the
jaredfholgate-docs-command-cleanup
branch
September 8, 2026 20:56
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
Follow-up to #20183 that incorporates Anthony's post-merge feedback and the useful parts of the closed reference #20223.
docscommand group and generation handler inDocsGenerateCommandbicepconfig.jsonthe source of template file and include-root settingsdocumentation.template.valuesfrom configuration and reject it with an actionable errorMicrosoft.Extensions.FileSystemGlobbingdependency becauseBicep.Coreuses it directlyBehavior
--template-fileand--template-rootare removed. Templates are selected throughdocumentation.template.fileanddocumentation.template.includeRoot.--custom-template-valueand--custom-template-value-file-pathremain repeatable and are applied in command-line order. JSON-RPC similarly accepts per-request custom values while resolving templates frombicepconfig.json.Pattern compilation diagnostics continue to allow valid modules to render. Setup, template, filesystem, and write exceptions stop the command, matching existing CLI commands.
AVM tooling
Azure/azure-verified-modules-tools PR #101 updates the parity tooling to configure one dispatcher template through
bicepconfig.jsonwhile keeping per-module values invocation-specific.The final full validation used
Azure/bicep-registry-modulescommit96a1dcb69b9bbb9c56638c4f5c457914d3e8bd21:avm/ptn/app/container-job-toolkitavm/ptn/sa/conversation-knowledge-miningValidation
Bicep.slnbuild: 0 warnings, 0 errorsBicep.Cli.IntegrationTests: 1,133 passedBicep.Core.UnitTests: 7,202 passedBicep.RpcClient.Tests: 95 passed, 1 skippedMicrosoft Reviewers: Open in CodeFlow