Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

XS✔ ◾ Documentation: Adding Classic Azure DevOps details #471

Merged
merged 2 commits into from Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/azure-pipelines-task.md
Expand Up @@ -66,6 +66,29 @@ steps:
continueOnError: true
```

## Classic Pipelines

For classic pipelines, you need to specify the secret as an environment
variable.

First, create a new environment variable in the pipeline definition under the
variables tab with the name `PR_Metrics_Access_Token` and the value of the PAT
as outlined above. Mark the variable as a secret to ensure it is not exposed in
the logs.

![Screenshot of the variable definition](images/variable-definition.png)

Then, add the task to the pipeline and expose the secret as an environment
variable. To do this, expand the "Environment Variables" section and press "+"
to add a new variable. In the first text box, add `PR_METRICS_ACCESS_TOKEN` and
in the second, add `$(PR_Metrics_Access_Token)`.

![Screenshot of the task definition](images/task-definition.png)

You can use a name other than `PR_Metrics_Access_Token` if you wish, but you
will need to keep the name unified across the variable and task definitions. The
name `PR_METRICS_ACCESS_TOKEN` cannot be altered.

## Always Close Comment

The `AlwaysCloseComment` option is not available for GitHub PRs as the main size
Expand Down
Binary file added docs/images/task-definition.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/variable-definition.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.