Skip to content

Commit 92797ae

Browse files
authored
Merge pull request #93 from microsoft/automated-documentation-update-20322621189
Automated documentation update
2 parents 95d3507 + 2b9161d commit 92797ae

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

src/artifacts-helper/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,21 @@ This ensures any custom scripting in place during Codespaces build process will
8585
The shim scripts (e.g., `dotnet`, `npm`, `nuget`) now include a wait mechanism for the Azure DevOps authentication helper. When invoked, these scripts will:
8686

8787
1. Wait up to 3 minutes for the `ado-auth-helper` to become available (configurable via `MAX_WAIT` environment variable)
88-
2. Display progress indicators every 20 seconds while waiting
88+
2. Display progress indicators every 20 seconds while waiting (only when `ARTIFACTS_HELPER_VERBOSE=true`)
8989
3. Continue execution once authentication is successful
9090
4. **Continue with the underlying command even if authentication is not available** after the timeout
9191

92+
By default, the authentication process runs silently. To enable verbose logging (useful for troubleshooting), set the `ARTIFACTS_HELPER_VERBOSE` environment variable to `true`:
93+
94+
```bash
95+
export ARTIFACTS_HELPER_VERBOSE=true
96+
```
97+
98+
When verbose mode is enabled, you will see step-by-step messages like:
99+
- `::step::Waiting for AzDO Authentication Helper...`
100+
- `::step::Running ado-auth-helper get-access-token...`
101+
- `::step::✓ Access token retrieved successfully`
102+
92103
This ensures that package restore operations can proceed even if there's a slight delay in the authentication helper installation, which can occur in some codespace initialization scenarios. Commands will still execute without authentication, though they may fail to access private Azure Artifacts feeds.
93104

94105
The scripts are designed to be sourced safely, meaning they won't terminate the calling shell if authentication fails - they will simply return an error code and allow the underlying tool to execute. This allows you to work with public packages or other package sources even when Azure Artifacts authentication is unavailable.

0 commit comments

Comments
 (0)