Copilot instructions

1---
2applyTo: ".pipelines/**/*.{yml,yaml}"
3---
4 
5# OneBranch Restore Phase Pattern
6 
7## Overview
8When steps need to run in the OneBranch restore phase (before the main build phase), the `ob_restore_phase` environment variable must be set in the `env:` block of **each individual step**.
9 
10## Pattern
11 
12### ✅ Correct (Working Pattern)
13```yaml
14parameters:
15- name: "ob_restore_phase"
16  type: boolean
17  default: true  # or false if you don't want restore phase
18
19steps:
20- powershell: |
21    # script content
22  displayName: 'Step Name'
23  env:
24    ob_restore_phase: ${{ parameters.ob_restore_phase }}
25```
26 
27The key is to:
281. Define `ob_restore_phase` as a **boolean** parameter
292. Set `ob_restore_phase: ${{ parameters.ob_restore_phase }}` directly in each step's `env:` block
303. Pass `true` to run in restore phase, `false` to run in normal build phase
31 
32### ❌ Incorrect (Does Not Work)
33```yaml
34steps:
35- powershell: |
36    # script content
37  displayName: 'Step Name'
38  ${{ if eq(parameters.useRestorePhase, 'yes') }}:
39    env:
40      ob_restore_phase: true
41```
42 
43Using conditionals at the same indentation level as `env:` causes only the first step to execute in restore phase.
44 
45## Parameters
46 
47Templates using this pattern should accept an `ob_restore_phase` boolean parameter:
48 
49```yaml
50parameters:
51- name: "ob_restore_phase"
52  type: boolean
53  default: true  # Set to true to run in restore phase by default
54```
55 
56## Reference Examples
57 
58Working examples of this pattern can be found in:
59- `.pipelines/templates/insert-nuget-config-azfeed.yml` - Demonstrates the correct pattern
60- `.pipelines/templates/SetVersionVariables.yml` - Updated to use this pattern
61 
62## Why This Matters
63 
64The restore phase in OneBranch pipelines runs before signing and other build operations. Steps that need to:
65- Set environment variables for the entire build
66- Configure authentication
67- Prepare the repository structure
68 
69Must run in the restore phase to be available when subsequent stages execute.
70 
71## Common Use Cases
72 
73- Setting `REPOROOT` variable
74- Configuring NuGet feeds with authentication
75- Setting version variables
76- Repository preparation and validation
77 
78## Troubleshooting
79 
80If only the first step in your template is running in restore phase:
811. Check that `env:` block exists for **each step**
822. Verify the conditional `${{ if ... }}:` is **inside** the `env:` block
833. Confirm indentation is correct (conditional is indented under `env:`)
84