Skip to content

[release/v7.6.1] Correct Variable Template Reference in NonOfficial Pipeline Templates #27317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jshigetomi merged 1 commit into from
Apr 21, 2026
Merged

[release/v7.6.1] Correct Variable Template Reference in NonOfficial Pipeline Templates #27317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 34 additions & 18 deletions .github/agents/SplitADOPipelines.agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ tools: ['vscode', 'execute', 'read', 'agent', 'edit', 'search', 'todo']

This agent will implement and restructure the repository's existing ADO pipelines into Official and NonOfficial pipelines.

A repository will have under the ./pipelines directory a series of yaml files that define the ADO pipelines for the repository.
A repository will have under the .pipelines directory a series of yaml files that define the ADO pipelines for the repository.

First confirm if the pipelines are using a toggle switch for Official and NonOfficial. This will look something like this

Expand All @@ -25,23 +25,39 @@ extends:

This is an indicator that this work needs to be done. This toggle switch is no longer allowed and the templates need to be hard coded.

## Template Reference Convention (MUST follow)

All `- template:` references to files **inside this repo** must use the **absolute** form anchored at the repo root, with the `@self` suffix:

```yaml
- template: /.pipelines/templates/<path>/<file>.yml@self
```

Do **not** use relative paths such as `templates/...`, `../templates/...`, or bare filenames. Rationale:

- Absolute paths resolve identically regardless of where the referring file lives, so moving a pipeline file between directories (for example, into `.pipelines/NonOfficial/`) does not silently break includes.
- Relative paths are resolved by Azure DevOps against the directory of the referring file, which has caused real outages in this repo when a relative include was composed into a nonexistent nested path like `.pipelines/templates/stages/.pipelines/templates/...`.
- The majority of existing includes already use the absolute form; keeping new work consistent reduces review burden.

The only acceptable non-absolute references are to external repositories resolved via the `resources.repositories` block, for example `v2/OneBranch.Official.CrossPlat.yml@onebranchTemplates`.
Comment on lines +28 to +42
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

The new guidance says all in-repo - template: references must use the absolute /.pipelines/...@self form and that relative/bare filenames are not acceptable. This isn’t currently true in this repo (e.g., .pipelines/templates/linux-package-build.yml and .pipelines/templates/mac-package-build.yml use - template: SetVersionVariables.yml@self and other relative includes). Please either (a) narrow the guidance to entrypoint pipeline YAMLs and templates expected to be referenced from multiple directories, or (b) update the existing templates to match the stated convention so the doc doesn’t mislead future changes.

Copilot uses AI. Check for mistakes.

## Refactoring Steps

### Step 1: Extract Shared Templates

For each pipeline file that uses the toggle switch pattern (e.g., `PowerShell-Packages.yml`):
For each pipeline file that uses the toggle switch pattern (e.g., `PowerShell-Packages-Official.yml`):

1. Create a `./pipelines/templates` directory if it doesn't exist
2. Extract the **variables section** into `./pipelines/templates/PowerShell-Packages-Variables.yml`
3. Extract the **stages section** into `./pipelines/templates/PowerShell-Packages-Stages.yml`
1. Create the `.pipelines/templates/variables` and `.pipelines/templates/stages` directories if they don't exist
2. Extract the **variables section** into `.pipelines/templates/variables/PowerShell-Packages-Variables.yml`
3. Extract the **stages section** into `.pipelines/templates/stages/PowerShell-Packages-Stages.yml`

**IMPORTANT**: Only extract the `variables:` and `stages:` sections. All other sections (parameters, resources, extends, etc.) remain in the pipeline files.

### Step 2: Create Official Pipeline (In-Place Refactoring)

The original toggle-based file becomes the Official pipeline:

1. **Keep the file in its original location** (e.g., `./pipelines/PowerShell-Packages.yml` stays where it is)
1. **Keep the file in its original location** (e.g., `.pipelines/PowerShell-Packages-Official.yml` stays where it is)
2. Remove the toggle switch parameter (`templateFile` parameter)
3. Hard-code the Official template reference:
```yaml
Expand All @@ -51,18 +67,18 @@ The original toggle-based file becomes the Official pipeline:
4. Replace the `variables:` section with a template reference:
```yaml
variables:
- template: templates/PowerShell-Packages-Variables.yml
- template: /.pipelines/templates/variables/PowerShell-Packages-Variables.yml@self
```
5. Replace the `stages:` section with a template reference:
```yaml
stages:
- template: templates/PowerShell-Packages-Stages.yml
- template: /.pipelines/templates/stages/PowerShell-Packages-Stages.yml@self
```

### Step 3: Create NonOfficial Pipeline

1. Create `./pipelines/NonOfficial` directory if it doesn't exist
2. Create the NonOfficial pipeline file (e.g., `./pipelines/NonOfficial/PowerShell-Packages-NonOfficial.yml`)
1. Create `.pipelines/NonOfficial` directory if it doesn't exist
2. Create the NonOfficial pipeline file (e.g., `.pipelines/NonOfficial/PowerShell-Packages-NonOfficial.yml`)
3. Copy the structure from the refactored Official pipeline
4. Hard-code the NonOfficial template reference:
```yaml
Expand All @@ -72,13 +88,13 @@ The original toggle-based file becomes the Official pipeline:
5. Reference the same shared templates:
```yaml
variables:
- template: ../templates/PowerShell-Packages-Variables.yml
- template: /.pipelines/templates/variables/PowerShell-Packages-Variables.yml@self

stages:
- template: ../templates/PowerShell-Packages-Stages.yml
- template: /.pipelines/templates/stages/PowerShell-Packages-Stages.yml@self
```

**Note**: The NonOfficial pipeline uses `../templates/` because it's one directory deeper than the Official pipeline.
**Note**: Always use **absolute** template paths of the form `/.pipelines/templates/...@self`. Do not use relative paths like `templates/...` or `../templates/...`. Absolute paths are anchored at the repo root and resolve consistently from any referring file, preventing breakage when files are moved between directories.

### Step 4: Link NonOfficial Pipelines to NonOfficial Dependencies

Expand Down Expand Up @@ -124,29 +140,29 @@ Then you must configure the `ob_release_environment` parameter when referencing

#### Official Pipeline Configuration

In the Official pipeline (e.g., `./pipelines/PowerShell-Packages.yml`):
In the Official pipeline (e.g., `.pipelines/PowerShell-Packages-Official.yml`):

```yaml
stages:
- template: templates/PowerShell-Packages-Stages.yml
- template: /.pipelines/templates/stages/PowerShell-Packages-Stages.yml@self
parameters:
ob_release_environment: Production
```

#### NonOfficial Pipeline Configuration

In the NonOfficial pipeline (e.g., `./pipelines/NonOfficial/PowerShell-Packages-NonOfficial.yml`):
In the NonOfficial pipeline (e.g., `.pipelines/NonOfficial/PowerShell-Packages-NonOfficial.yml`):

```yaml
stages:
- template: ../templates/PowerShell-Packages-Stages.yml
- template: /.pipelines/templates/stages/PowerShell-Packages-Stages.yml@self
parameters:
ob_release_environment: Test
```

#### Update Stages Template to Accept Parameter

The extracted stages template (e.g., `./pipelines/templates/PowerShell-Packages-Stages.yml`) must declare the parameter at the top:
The extracted stages template (e.g., `.pipelines/templates/stages/PowerShell-Packages-Stages.yml`) must declare the parameter at the top:

```yaml
parameters:
Expand Down
5 changes: 3 additions & 2 deletions .pipelines/NonOfficial/PowerShell-Coordinated_Packages-NonOfficial.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ resources:
ref: refs/heads/main

variables:
- template: ./pipelines/templates/variables/PowerShell-Coordinated_Packages-Variables.yml@self
- template: /.pipelines/templates/variables/PowerShell-Coordinated_Packages-Variables.yml@self
parameters:
InternalSDKBlobURL: ${{ parameters.InternalSDKBlobURL }}
ReleaseTagVar: ${{ parameters.ReleaseTagVar }}
Expand All @@ -61,6 +61,7 @@ extends:
LinuxHostVersion:
Network: KS3
WindowsHostVersion:
Version: 2022
Network: KS3
Comment on lines 63 to 65
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

This adds WindowsHostVersion.Version: 2022, which changes the build host selection (behavioral pipeline change) beyond the PR description’s claim of “straightforward path corrections with no logic modifications”. If this host version pin is required, please call it out in the PR description/testing notes (or drop it from this backport if it wasn’t intended).

Copilot uses AI. Check for mistakes.
incrementalSDLBinaryAnalysis: true
globalSdl:
Expand Down Expand Up @@ -90,7 +91,7 @@ extends:
tsaOptionsFile: .config\tsaoptions.json

stages:
- template: ./pipelines/templates/stages/PowerShell-Coordinated_Packages-Stages.yml@self
- template: /.pipelines/templates/stages/PowerShell-Coordinated_Packages-Stages.yml@self
parameters:
RUN_WINDOWS: ${{ parameters.RUN_WINDOWS }}
RUN_TEST_AND_RELEASE: ${{ parameters.RUN_TEST_AND_RELEASE }}
Expand Down
4 changes: 2 additions & 2 deletions .pipelines/NonOfficial/PowerShell-Packages-NonOfficial.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ parameters: # parameters are shown up in ADO UI in a build queue time
name: pkgs-$(BUILD.SOURCEBRANCHNAME)-nonofficial-$(Build.BuildId)

variables:
- template: ./pipelines/templates/variables/PowerShell-Packages-Variables.yml@self
- template: /.pipelines/templates/variables/PowerShell-Packages-Variables.yml@self
parameters:
debug: ${{ parameters.debug }}
ForceAzureBlobDelete: ${{ parameters.ForceAzureBlobDelete }}
Expand Down Expand Up @@ -92,6 +92,6 @@ extends:
enabled: false
tsaOptionsFile: .config\tsaoptions.json
stages:
- template: ./pipelines/templates/stages/PowerShell-Packages-Stages.yml@self
- template: /.pipelines/templates/stages/PowerShell-Packages-Stages.yml@self
parameters:
OfficialBuild: false
2 changes: 1 addition & 1 deletion .pipelines/NonOfficial/PowerShell-Release-Azure-NonOfficial.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ parameters: # parameters are shown up in ADO UI in a build queue time
name: ev2-$(BUILD.SOURCEBRANCHNAME)-nonofficial-$(Build.BuildId)

variables:
- template: ./pipelines/templates/variables/PowerShell-Release-Azure-Variables.yml@self
- template: /.pipelines/templates/variables/PowerShell-Release-Azure-Variables.yml@self
parameters:
debug: ${{ parameters.debug }}

Expand Down
4 changes: 2 additions & 2 deletions .pipelines/NonOfficial/PowerShell-Release-NonOfficial.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ parameters: # parameters are shown up in ADO UI in a build queue time
name: release-$(BUILD.SOURCEBRANCHNAME)-nonofficial-$(Build.BuildId)

variables:
- template: ./pipelines/templates/variables/PowerShell-Release-Variables.yml@self
- template: /.pipelines/templates/variables/PowerShell-Release-Variables.yml@self
parameters:
debug: ${{ parameters.debug }}
ReleaseTagVar: ${{ parameters.ReleaseTagVar }}
Expand Down Expand Up @@ -98,7 +98,7 @@ extends:
tsaOptionsFile: .config\tsaoptions.json

stages:
- template: ./pipelines/templates/stages/PowerShell-Release-Stages.yml@self
- template: /.pipelines/templates/stages/PowerShell-Release-Stages.yml@self
parameters:
releaseEnvironment: Test
SkipPublish: ${{ parameters.SkipPublish }}
Expand Down
4 changes: 2 additions & 2 deletions .pipelines/NonOfficial/PowerShell-vPack-NonOfficial.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ parameters: # parameters are shown up in ADO UI in a build queue time
name: vPack_$(Build.SourceBranchName)_NonOfficial_Create.${{ parameters.createVPack }}_Name.${{ parameters.vPackName}}_$(date:yyyyMMdd).$(rev:rr)

variables:
- template: ./pipelines/templates/variables/PowerShell-vPack-Variables.yml@self
- template: /.pipelines/templates/variables/PowerShell-vPack-Variables.yml@self
parameters:
debug: ${{ parameters.debug }}
ReleaseTagVar: ${{ parameters.ReleaseTagVar }}
Expand Down Expand Up @@ -82,7 +82,7 @@ extends:
enabled: false
tsaOptionsFile: .config/tsaoptions.json
stages:
- template: ./pipelines/templates/stages/PowerShell-vPack-Stages.yml@self
- template: /.pipelines/templates/stages/PowerShell-vPack-Stages.yml@self
parameters:
createVPack: ${{ parameters.createVPack }}
vPackName: ${{ parameters.vPackName }}
2 changes: 1 addition & 1 deletion .pipelines/templates/stages/PowerShell-vPack-Stages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ stages:
env:
ob_restore_phase: true

- template: .pipelines/templates/SetVersionVariables.yml@self
- template: /.pipelines/templates/SetVersionVariables.yml@self
parameters:
ReleaseTagVar: $(ReleaseTagVar)
CreateJson: yes
Expand Down
Loading