Skip to content

Fix doc-drift in contribution guide post Apr–May 2026 CI rewrite#14755

Open
alex-frankel wants to merge 1 commit into
masterfrom
alfran/docs-fix-validate-command-and-workflow-references
Open

Fix doc-drift in contribution guide post Apr–May 2026 CI rewrite#14755
alex-frankel wants to merge 1 commit into
masterfrom
alfran/docs-fix-validate-command-and-workflow-references

Conversation

@alex-frankel
Copy link
Copy Markdown
Contributor

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 a summarize-pr.yml workflow that doesn't exist. The Bicep section also tells contributors to omit azuredeploy.json from the PR, which produces broken "Deploy to Azure" buttons because customers click those button links directly to azuredeploy.json in 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.yml matches startsWith(github.event.comment.body, '/validate').
  • Drop §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. Replaced with a one-line mention at the end of §2.
  • "Three workflows" → "Two workflows" in the section opener. Matches the two workflows that actually drive the contributor PR flow (validate-samples.yml and ValidateSampleDeployments.yml). auto-fix.yml exists but is maintainer-only workflow_dispatch, not part of the contributor flow.
  • Drop step 7 from the Contributor Workflow Summary (/summarize reference).
  • Bicep section: change "must not be included in the PR as it will be built automatically when the sample is merged" to "should be included in the PR (compiled output of main.bicep)". The "Deploy to Azure" / "Visualize" buttons in each sample's README link directly to azuredeploy.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 #14704Add key-vault-certificate-create template #14707 introduced and which @msmbaldwin's restore PRs (Add azuredeploy.json for key-vault-key-create #14739Restore azuredeploy.json for key-vault-create #14742, merged today) just fixed.

Notes for @ouldsid

cc @ouldsid

…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.
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.

1 participant