Skip to content

fix(pipelines): name templateRepository when template helpers are missing - #77

Merged
Paymaun (digimaun) merged 2 commits into
Azure:mainfrom
digimaun:fix/ado-consumer-templates
Oct 19, 2026
Merged

Paymaun (digimaun) merged 2 commits into
Azure:mainfrom
digimaun:fix/ado-consumer-templates

Conversation

@digimaun

Copy link
Copy Markdown
Member

Summary

  • Pipelines that reference the Azure Pipelines stage templates from another repository select that repository with templateRepository. A new first input step, "Check template helpers", stops with a message that names templateRepository when the helper scripts are missing. Site overrides check for their two helpers when SITE_OVERRIDES has a value.
  • The CI/CD guide describes the templates a consumer pipeline uses: the two stage templates, the supported setup-siteops.yaml, and the complete set of files to copy for each engine route. Troubleshooting covers the new messages and the existing release installation message.
  • A test keeps the parameter names, types and defaults of the consumer templates compatible, and requires a default for any new parameter.
  • The v1.0.0b7 migration guide section covers template repositories and copied templates, SITE_OVERRIDES, relative pipeline paths, deploy output streams, Azure deployment names, and OPC UA connector certificate settings on AIO 2603 through 2606. It describes diagnostic output without comparing it to output that v1.0.0b6 never produced, and qualifies the reported version for source installations.

Corrections to earlier migration sections

  • v1.0.0b6: a trailing -v exits with code 2, and a malformed include when: fails while the manifest loads.
  • v1.0.0b4, new section: the renamed deployment options have no aliases and the edge-site default changed, selectors repeat only name, SITE_OVERRIDES must be defined, pipeline manifest inputs are paths, Site and manifest loading is stricter, shared content paths moved, the Secret Sync template contract changed, and Manifest.from_file requires workspace_root.
  • v1.0.0b3, new section: Site overrides need scripts/generate-site-overrides.py in the caller checkout.

Validation

  • Unit tests for the template steps, including the new checks and the parameter contract. Fork CI passes.
  • Live Azure Pipelines runs against these templates, from a caller repository that references them and installs Site Ops from Git:
    • With templateRepository, validation succeeded, and an authenticated plan with SITE_OVERRIDES succeeded without deploying.
    • Without templateRepository, the run stopped at "Check template helpers" with the new message.

…sing

Pipelines that reference the Azure Pipelines stage templates from
another repository select that repository with templateRepository. A
new first input step stops with a message that names templateRepository
when the helper scripts are missing, and Site overrides check for their
helpers when SITE_OVERRIDES has a value.

The CI/CD guide describes the templates a consumer pipeline uses and
the complete set to copy for each engine route, and troubleshooting
covers the missing helper messages. A test keeps the consumer template
parameters compatible. The v1.0.0b7 migration guide covers template
repositories, copied templates, SITE_OVERRIDES and relative pipeline
paths, and the v1.0.0b6 section is corrected for a trailing -v.
The v1.0.0b7 section covers deploy output streams, Azure deployment
names longer than 49 characters, and OPC UA connector certificate
settings on AIO 2603 through 2606. The v1.0.0b6 section adds include
`when:` validation. New v1.0.0b4 and v1.0.0b3 sections correct and
supplement those releases' notes.
Copilot AI balanced review requested due to automatic review settings October 19, 2026 21:23

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approval recommended

The focused helper checks, supporting tests, and documentation changes have no identified blocking issues.

No open issues 🎉

What changed in this PR

This PR improves Azure Pipelines diagnostics for missing template helpers and clarifies consumer setup and migration guidance.

Changes:

  • Add early helper checks with actionable templateRepository guidance.
  • Test helper checks and preserve consumer template parameter compatibility.
  • Document matching template sets and correct migration notes.
File Description
tests/​test_ado_pipelines.py Add parameter compatibility checks and update helper fixtures.
tests/​test_ado_consumers.py Test missing helpers and conditional override checks.
docs/​troubleshooting.md Explain helper errors and remedies.
docs/​migrating.md Expand and correct release migration guidance.
docs/​ci-cd-setup.md Document template references and complete copy sets.
.pipelines/​templates/​siteops-inputs.yaml Check required helpers with actionable errors.

Review effort: Balanced

@digimaun
Paymaun (digimaun) merged commit 9814c1e into Azure:main Oct 19, 2026
14 checks passed
@digimaun
Paymaun (digimaun) deleted the fix/ado-consumer-templates branch October 19, 2026 22:01
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.

3 participants