ExternalVendorCode/onefuzz
1
0
Fork 0
mirror of https://github.com/microsoft/onefuzz.git synced 2025-06-18 12:48:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add more setup info to check-pr docs (#1311)

Browse Source
This commit is contained in:
Joe Ranweiler
2021-10-05 13:12:35 -07:00
committed by GitHub
parent 098cd20550
commit 124da2378f
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/utils/check-pr/README.md
View File

@ -1,8 +1,20 @@
# PR integration test tool
Requirements:
## Requirements
* Python packages (See `requirements.txt`)
* Python >= 3.7, and dependencies (see `requirements.txt`)
* [az-cli](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli).
* [azcopy](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-azcopy-v10)
* [azure-functions-core-tools](https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local?tabs=v3%2Clinux%2Ccsharp%2Cportal%2Cbash%2Ckeda#install-the-azure-functions-core-tools)
## Setup
1. In GitHub, generate a personal access token (PAT) with the `public_repo` scope.
You may need to enable SSO for the token, depending on the org that your OneFuzz fork belongs to.
1. Set `GITHUB_ISSUE_TOKEN` equal to the above PAT in your shell session.
[`direnv`](https://direnv.net/) can help here.
1. Create and activate a virtualenv, e.g. `python -m venv venv` followed by `. ./venv/bin/activate` (e.g. on Linux).
1. Install dependencies with `pip install -r requirements.txt`
You can now invoke `check-pr.py`.
See `./check-pr.py -h` for available commands.