Fix doc-drift in contribution guide post Apr–May 2026 CI rewrite#14755
Open
alex-frankel wants to merge 1 commit into
Open
Fix doc-drift in contribution guide post Apr–May 2026 CI rewrite#14755alex-frankel wants to merge 1 commit into
alex-frankel wants to merge 1 commit into
Conversation
…stent summarize-pr.yml, correct Bicep azuredeploy.json guidance - Maintainer command is /validate, not /verify (7 occurrences updated). - Remove §3 "Summarize PR (summarize-pr.yml)" — that workflow doesn't exist. The AI summary is a job inside ValidateSampleDeployments.yml and fires automatically alongside /validate; folded a one-line mention into §2. - Update "Two workflows" instead of "Three workflows" in section opener. - Drop step 7 from Contributor Workflow Summary (no /summarize command). - Bicep section: azuredeploy.json should be included in the PR (compiled output of main.bicep). The "Deploy to Azure"/"Visualize" buttons link directly to it. Earlier wording said it would be auto-generated on merge, which is the design intent but doesn't reflect what works today.
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.
Why
The contribution guide (
1-CONTRIBUTION-GUIDE/README.md) has drifted from what the workflows actually do, post Ould's Apr–May 2026 CI rewrite. New contributors following the doc verbatim will be told to type/verify(which does nothing — the workflow listens for/validate) and to expect asummarize-pr.ymlworkflow that doesn't exist. The Bicep section also tells contributors to omitazuredeploy.jsonfrom the PR, which produces broken "Deploy to Azure" buttons because customers click those button links directly toazuredeploy.jsonin master.Surfaced while running #14752 as a canary for the new pipeline.
What changed
/verify→/validate(7 occurrences in §2, the Contributor Workflow Summary, and the Diagnosing Failures section). The workflow source is the source of truth:ValidateSampleDeployments.ymlmatchesstartsWith(github.event.comment.body, '/validate').summarize-pr.yml)". That workflow doesn't exist. The AI summary is a job insideValidateSampleDeployments.ymland fires automatically alongside/validate. Replaced with a one-line mention at the end of §2.validate-samples.ymlandValidateSampleDeployments.yml).auto-fix.ymlexists but is maintainer-onlyworkflow_dispatch, not part of the contributor flow./summarizereference).main.bicep)". The "Deploy to Azure" / "Visualize" buttons in each sample's README link directly toazuredeploy.json, so it must exist in the sample folder on master. Without it, the buttons 404 — which is exactly the breakage Update key-vault-create template to use RBAC instead of access policies #14704–Add key-vault-certificate-create template #14707 introduced and which @msmbaldwin's restore PRs (Add azuredeploy.json for key-vault-key-create #14739–Restore azuredeploy.json for key-vault-create #14742, merged today) just fixed.Notes for @ouldsid
commit-generated-on-mergejob inValidateSampleDeployments.ymlis the design path that would let contributors omitazuredeploy.jsonand have CI commit it for them. That's a great destination. Until commit-generated-on-merge writes azuredeploy.json to repo root, not the sample folder (path-stripping in upload-artifact@v4) #14754 (path-stripping bug) is fixed and the flow is reliable, the doc should describe what works today, which is "compile + commit it yourself." Once commit-generated-on-merge writes azuredeploy.json to repo root, not the sample folder (path-stripping in upload-artifact@v4) #14754 lands, this section can be updated again to mention the auto-gen path as a contributor option.cc @ouldsid