Skip to content

Commit a5a1d83

Browse files
docs(site): document --include-disabled flag for secrets commands
Add the --include-disabled flag (introduced in #914) to the CLI reference for secrets set, list, and delete. Also expand the project-scope discovery section to explain the new default pruning behaviour and when to use the opt-out flag. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent f7e9d17 commit a5a1d83

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ Options:
8383
- `--definition-ids <ids>` -- explicit comma-separated definition IDs (skips auto-detection); mutually exclusive with `--all-repos` / `--source`
8484
- `--all-repos` -- **project-scope mode**: search every ado-aw definition in the ADO project, not just those with a local lock file; mutually exclusive with `--definition-ids`
8585
- `--source <path>` -- filter to definitions whose `# ado-aw-metadata` marker references this template path (e.g. `agents/security-scan.md`); activates the discovery code path; pairs with `--all-repos` to scope across the whole project
86+
- `--include-disabled` -- include `disabled` / `paused` definitions in project-wide discovery (only effective with `--all-repos` or `--source`); by default disabled and paused definitions are skipped to speed up the Preview step
8687
- `--dry-run` -- print the planned set without calling the ADO API
8788

8889
### `secrets list [path]`
@@ -94,6 +95,7 @@ Options:
9495
- `--json` -- emit machine-readable JSON
9596
- `--org`, `--project`, `--pat`, `--definition-ids` -- same as `secrets set`
9697
- `--all-repos`, `--source` -- same as `secrets set`
98+
- `--include-disabled` -- same as `secrets set`
9799

98100
### `secrets delete <name> [path]`
99101

@@ -103,6 +105,7 @@ Options:
103105

104106
- `--org`, `--project`, `--pat`, `--definition-ids` -- same as `secrets set`
105107
- `--all-repos`, `--source` -- same as `secrets set`
108+
- `--include-disabled` -- same as `secrets set`
106109
- `--dry-run` -- print the planned deletion without calling the ADO API
107110

108111
### Project-scope discovery (`--all-repos` / `--source`)
@@ -114,6 +117,8 @@ By default, `secrets` commands match ADO definitions by scanning **local lock fi
114117

115118
Both flags are mutually exclusive with `--definition-ids`. `--definition-ids` remains the explicit-ID escape hatch when you know exactly which definitions to target.
116119

120+
**Disabled and paused definitions** are pruned by default during project-wide discovery: the Preview step is expensive, so `disabled` / `paused` definitions are skipped before the expansion call to keep large projects fast. Definitions with no reported status are treated as active. Pass **`--include-disabled`** to include them — useful when you need to rotate a token on a pipeline that is temporarily paused.
121+
117122
:::caution[Not available for other lifecycle commands]
118123
`enable`, `disable`, `remove`, `list`, `status`, and `run` are **not** affected by these flags — they retain their local-fixture-scoped safety semantics. Only `secrets` commands support project-scope discovery because token rotation is the primary use case for cross-repo operations.
119124
:::
@@ -127,6 +132,9 @@ ado-aw secrets set GITHUB_TOKEN --all-repos --source agents/security-scan.md
127132

128133
# Preview which definitions would be updated
129134
ado-aw secrets set GITHUB_TOKEN --all-repos --dry-run
135+
136+
# Include disabled/paused pipelines in the sweep (e.g. to rotate their token before re-enabling)
137+
ado-aw secrets set GITHUB_TOKEN --all-repos --include-disabled
130138
```
131139

132140
### `enable [path]`

0 commit comments

Comments
 (0)