From 8a16230a98a1ac04a2e70a200f5432e6fae7c6c3 Mon Sep 17 00:00:00 2001 From: To Huynh Date: Fri, 23 Apr 2021 18:20:00 -0700 Subject: [PATCH] Rename workflows to have manual --- .../{get_next_uv_dates.yml => get_next_uv_dates-manual.yml} | 2 +- .github/workflows/run-qa-test-manual.yml | 2 +- docs/get_next_uv_dates.md | 2 +- docs/run_qa_test.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) rename .github/workflows/{get_next_uv_dates.yml => get_next_uv_dates-manual.yml} (97%) diff --git a/.github/workflows/get_next_uv_dates.yml b/.github/workflows/get_next_uv_dates-manual.yml similarity index 97% rename from .github/workflows/get_next_uv_dates.yml rename to .github/workflows/get_next_uv_dates-manual.yml index e52f9df..e24600e 100644 --- a/.github/workflows/get_next_uv_dates.yml +++ b/.github/workflows/get_next_uv_dates-manual.yml @@ -1,4 +1,4 @@ -name: Get next update and verify dates +name: Manual Get next update and verify dates on: workflow_dispatch: diff --git a/.github/workflows/run-qa-test-manual.yml b/.github/workflows/run-qa-test-manual.yml index 8a1e923..7cb9cb5 100644 --- a/.github/workflows/run-qa-test-manual.yml +++ b/.github/workflows/run-qa-test-manual.yml @@ -1,4 +1,4 @@ -name: Run QA Test +name: Manual Run QA Test on: workflow_dispatch: diff --git a/docs/get_next_uv_dates.md b/docs/get_next_uv_dates.md index 9deb942..e214f27 100644 --- a/docs/get_next_uv_dates.md +++ b/docs/get_next_uv_dates.md @@ -17,7 +17,7 @@ ## GitHub Actions (for collaborators+ only) 1. Visit https://github.com/SIGLA-GU/siglatools/actions. -2. From the list of workflows, select `Get next update and verify dates`. +2. From the list of workflows, select `Manual Get next update and verify dates`. 3. Click on the `Run workflow` dropdown button. 4. Enter a start date and an end date. Make sure they are in YYYY-MM-DD format and start date is less than or equal to end date. 5. Click on the green `Run workflow` button to run the workflow. diff --git a/docs/run_qa_test.md b/docs/run_qa_test.md index 4c96fe4..cc7e317 100644 --- a/docs/run_qa_test.md +++ b/docs/run_qa_test.md @@ -17,7 +17,7 @@ ## GitHub Actions (for collaborators+ only) 1. Visit https://github.com/SIGLA-GU/siglatools/actions. -2. From the list of workflows, select `Run QA Test`. +2. From the list of workflows, select `Manual Run QA Test`. 3. Click on the `Run workflow` dropdown button. 4. Enter a list of `spreadsheetId`s, delimited by `,`. For example `spreadsheetId-1,spreadsheetId-2,spreadsheetId-3`. 5. Enter a database environment, `staging` or `production`. Choose `staging` if you want to compare the spreadsheet(s) in step 4 with the `staging` database. Choose `production` if you want to compare the spreadsheet(s) in step 4 with the `production` database. @@ -26,7 +26,7 @@ 8. On the workflow details page, once the run is finished click on the `qa-test-artifact` to download a zip file. ## QA Test Artifact Zip File -The zip file contains any mismatches between the data in the GoogleSheet and the data in the database. One file for each institution, if there are mismatches between the institution in the GoogleSheet and the institution in the database. The files are organized by the spreadsheet they belong to. There is an additional file `extra-institutions.csv`, which contains institutions in the database, but for some reason, doesn't have a counterpart institution in the GoogleSheet. If there are no files in zip file, then the QA script found no mismatches for the given spreadsheets. +The zip file contains any mismatches between the data in the GoogleSheet and the data in the database. One file for each institution, if there are mismatches between the institution in the GoogleSheet and the institution in the database. The files are organized by the spreadsheet they belong to. There is an additional file `extra-institutions.csv`, which contains institutions in the database, but for some reason, doesn't have a counterpart institution in the GoogleSheet. If there are no files in the zip file, then the QA script found no mismatches for the given spreadsheets. ## Spreadsheet Ids Format