pra-check v1.0.7
PRA Check
This package exposes a CLI that checks if a Pull request has a PRA value available on the linked userstory or it's parent feature. To do these checks the REST apis of Azure DevOps services are used.
Unfortunately for now it is not possible to call the Azure DevOps apis using a service principal: docs
Therefore we will use a PAT (Personal Access Token) docs.
The following options are available and required:
| short option | long option | description |
|---|---|---|
| -P | --project | Azure DevOps project (name or id) |
| -p | --prid | Azure DevOps PR id |
| -r | --repo | Azure Devops repository (name or id) |
| -u | --user | Stedin user |
In case you will use the project or repository names make sure to escape spaces.
The last option necessary is the env variable PAT_TOKEN. This one is not available to provide using the CLI but must be provided using the
environment.
To use this CLI in a Azure DevOps pipeline follow these steps:
- Create a PAT for the user you wish to use for the checks. See the MS docs above to generate one.
- Add a step to your pipeline to install node.js
- Add a step to use the CLI provided by this package.
There is an example yaml file in the samples folder. As seen there the project / repository and pull request id are taken from the variables available in the pipeline.
The only variables you need to add are PAT_USER and PAT_TOKEN. The PAT_USER can be maintained in the pipeline or in code.
docs
For the PAT_TOKEN it would be a bad practice to have it in code as it will no longer be secret therefore follow these
instructions or use
a keyvault