Skip to content

Commit f8bfcf9

Browse files
docs(site): replace deprecated ado-aw configure with secrets set GITHUB_TOKEN (#741)
1 parent 8b10d17 commit f8bfcf9

3 files changed

Lines changed: 15 additions & 9 deletions

File tree

site/src/content/docs/introduction/how-it-works.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Only approved proposals continue to the next stage.
2828

2929
### 3. SafeOutputs
3030

31-
The third stage applies approved actions with a separate write-capable token.This stage can create or update Azure DevOps resources such as pull requests, comments, work items, and related artifacts.
31+
The third stage applies approved actions with a separate write-capable token. This stage can create or update Azure DevOps resources such as pull requests, comments, work items, and related artifacts.
3232

3333
Because the write credential is isolated from the agent, the system keeps a strong boundary between reasoning and mutation.
3434

site/src/content/docs/setup/cli.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,12 @@ Options:
252252
- `--ado-project <name>` -- Azure DevOps project name override
253253
- `--dry-run` -- validate inputs without making write calls
254254

255+
## Deprecated commands
256+
257+
### `configure` (deprecated alias)
258+
259+
`ado-aw configure` is a hidden alias for `ado-aw secrets set GITHUB_TOKEN`. It emits a deprecation warning and will be removed in a future release. Use `ado-aw secrets set GITHUB_TOKEN` instead.
260+
255261
## Common examples
256262

257263
```bash

site/src/content/docs/setup/quick-start.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,14 @@ The agent will walk you through the front-matter configuration, write the agent
7676

7777
### 3. Push and configure
7878

79-
Once you're happy with the generated files, commit and push them to your Azure DevOps repository. Then create a pipeline in Azure DevOps pointing at the compiled `.lock.yml` file, and configure it:
79+
Once you're happy with the generated files, commit and push them to your Azure DevOps repository. Then create a pipeline in Azure DevOps pointing at the compiled `.lock.yml` file, and set the required `GITHUB_TOKEN` pipeline variable:
8080

8181
```bash
82-
ado-aw configure
82+
ado-aw secrets set GITHUB_TOKEN
8383
```
8484

85-
This sets the `GITHUB_TOKEN` pipeline variable on the ADO build definition. The command prompts for:
86-
- A **GitHub Personal Access Token (PAT)** -- used by the Copilot CLI at runtime (see [required permissions](#github-pat-permissions) below)
85+
This stores the `GITHUB_TOKEN` pipeline variable (as a secret) on every matched ADO build definition. The command prompts for:
86+
- The **GitHub Personal Access Token (PAT)** value -- used by the Copilot CLI at runtime (see [required permissions](#github-pat-permissions) below)
8787
- For Azure DevOps authentication, the command first tries the **Azure CLI** (`az` login session). If the Azure CLI is not available or not logged in, it falls back to prompting for an **Azure DevOps PAT**.
8888

8989
#### Service connections for ADO access
@@ -151,13 +151,13 @@ This writes a compiled `.lock.yml` pipeline alongside the source file. You shoul
151151
3. In Azure DevOps, create a pipeline that points at the compiled YAML file.
152152
4. Save the pipeline.
153153

154-
### 4. Configure the pipeline
154+
### 4. Set the GitHub token
155155

156156
```bash
157-
ado-aw configure
157+
ado-aw secrets set GITHUB_TOKEN
158158
```
159159

160-
This sets the `GITHUB_TOKEN` pipeline variable. See the [With Agents](#3-push-and-configure) section above for details on what the command prompts for and the current GitHub PAT limitation.
160+
This stores the `GITHUB_TOKEN` pipeline variable (as a secret) on every matched ADO build definition. See the [With Agents](#3-push-and-configure) section above for details on what the command prompts for and the current GitHub PAT limitation.
161161

162162
If your workflow uses write-requiring safe outputs, you'll also need an ARM service connection — see [Service Connections](/ado-aw/setup/service-connections/).
163163

@@ -182,7 +182,7 @@ No repository permissions are needed -- the token is only used for Copilot infer
182182
GitHub App tokens and OAuth tokens are **not supported** for this secret. Only fine-grained PATs work. The token owner's account must have an active Copilot license.
183183
:::
184184

185-
The token is stored as the `GITHUB_TOKEN` pipeline variable on your Azure DevOps build definition (set by `ado-aw configure`). It is never exposed to the agent -- only the pipeline runtime uses it.
185+
The token is stored as the `GITHUB_TOKEN` pipeline variable on your Azure DevOps build definition (set by `ado-aw secrets set GITHUB_TOKEN`). It is never exposed to the agent -- only the pipeline runtime uses it.
186186

187187
---
188188

0 commit comments

Comments
 (0)