From cd0e27446ad6f5a955a867ead1d45ff312131ee8 Mon Sep 17 00:00:00 2001 From: Jake Jackson Date: Tue, 18 Mar 2025 11:06:37 -0400 Subject: [PATCH] Update bug scrub docs (#15894) * Update docs with a few more things * update about use of PAT * update around managing output from the script * Fix spacing and empty line * finish run on sentence * update requirements with extra dep needed --- tools/community-bugscrub/README.md | 9 ++++++++- tools/community-bugscrub/requirements.txt | 1 + 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/tools/community-bugscrub/README.md b/tools/community-bugscrub/README.md index bc0e2201b5..30543a6c8c 100644 --- a/tools/community-bugscrub/README.md +++ b/tools/community-bugscrub/README.md @@ -16,4 +16,11 @@ Get the usage. ``` python generate-sheet.py -h -``` \ No newline at end of file +``` + +## Adding a github Personal Access Token +The scripts looks first for a github personal access token to use to avoid having the scripts calls rate limited, you can create one or use an existing one if you have. The script looks for the PAT under the environment var `GITHUB_ACCESS_TOKEN`. + + +# For internal spreadsheet usage +AWX engineers will need to import the data generated from the script into a spreadshet manager. Please make sure that you do not replace the existing sheets but make a new one or create a new sheet inside the existing spreadsheet upon import. \ No newline at end of file diff --git a/tools/community-bugscrub/requirements.txt b/tools/community-bugscrub/requirements.txt index 7907e70487..164b56f9b2 100644 --- a/tools/community-bugscrub/requirements.txt +++ b/tools/community-bugscrub/requirements.txt @@ -1,2 +1,3 @@ requests pyexcel +pyexcel-ods3