Skip to content

Commit 6e3f193

Browse files
authored
Merge pull request #87 from microsoft/automated-documentation-update-20236756036
Automated documentation update
2 parents 0d6101a + 701ebb8 commit 6e3f193

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/artifacts-helper/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Configures Codespace to authenticate with Azure Artifact feeds
77

88
```json
99
"features": {
10-
"ghcr.io/microsoft/codespace-features/artifacts-helper:2": {}
10+
"ghcr.io/microsoft/codespace-features/artifacts-helper:3": {}
1111
}
1212
```
1313

@@ -24,6 +24,7 @@ Configures Codespace to authenticate with Azure Artifact feeds
2424
| npxAlias | Create alias for npx | boolean | true |
2525
| rushAlias | Create alias for rush | boolean | true |
2626
| pnpmAlias | Create alias for pnpm | boolean | true |
27+
| shimDirectory | Directory where the shims will be installed. This must be in $PATH, and needs to be as early as possible in priority for the scripts to override the base executables. | string | /usr/local/share/codespace-shims |
2728
| targetFiles | Comma separated list of files to write to. Default is '/etc/bash.bashrc,/etc/zsh/zshrc' for root and '~/.bashrc,~/.zshrc' for non-root | string | DEFAULT |
2829
| python | Install Python keyring helper for pip | boolean | false |
2930

@@ -34,8 +35,8 @@ Configures Codespace to authenticate with Azure Artifact feeds
3435
- `ms-codespaces-tools.ado-codespaces-auth`
3536

3637
This installs [Azure Artifacts Credential Provider](https://github.com/microsoft/artifacts-credprovider)
37-
and optionally configures functions which shadow `dotnet`, `nuget`, `npm`, `yarn`, `rush`, and `pnpm` which dynamically sets an authentication token
38-
for pulling artifacts from a feed before running the command.
38+
and optionally configures shims which shadow `dotnet`, `nuget`, `npm`, `yarn`, `rush`, and `pnpm`.
39+
These dynamically sets an authentication token for pulling artifacts from a feed before running the command.
3940

4041
For `npm`, `yarn`, `rush`, and `pnpm` this requires that your `~/.npmrc` file is configured to use the ${ARTIFACTS_ACCESSTOKEN}
4142
environment variable for the `authToken`. A helper script has been added that you can use to write your `~/.npmrc`

0 commit comments

Comments
 (0)