#2671 Added GitHub workflow file for historic data migrator (#2738)

* #2671 Added GitHub workflow file for historic data migrator * #2671 Updated ReadMe and workflow * Update .github/workflows/historic-data-migrator.yml Co-authored-by: Alex Steel <[email protected]> * Update .github/workflows/historic-data-migrator.yml Co-authored-by: Alex Steel <[email protected]> * Update .github/workflows/historic-data-migrator.yml Co-authored-by: Alex Steel <[email protected]> --------- Co-authored-by: Alex Steel <[email protected]>
GSA-TTS · Nov 7, 2023 · ad1b6e7 · ad1b6e7
1 parent 2e56df4
commit ad1b6e7
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/.github/workflows/historic-data-migrator.yml b/.github/workflows/historic-data-migrator.yml
@@ -0,0 +1,42 @@
+---
+name: Historic Data Migration
+on:
+  workflow_dispatch:
+    inputs:
+      environment:
+        required: true
+        type: choice
+        description: The environment the workflow should run on.
+        options:
+          - dev
+          - staging
+          - preview
+      dbkeys:
+        required: false
+        type: string
+        description: Comma-separated list of report-IDs.
+      years:
+        required: false
+        type: string
+        description: Comma-separated list of report years. The list of years needs to be the same length as the list of dbkeys.
+
+jobs:
+  historic-data-migrator:
+    name: Generate and disseminate historic data in ${{ inputs.environment }} database
+    runs-on: ubuntu-latest
+    environment: ${{ inputs.environment }}
+    env:
+      space: ${{ inputs.environment }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Run Django command to generate and disseminate historic data in ${{ inputs.environment }}
+        uses: cloud-gov/cg-cli-tools@main
+        with:
+          cf_username: ${{ secrets.CF_USERNAME }}
+          cf_password: ${{ secrets.CF_PASSWORD }}
+          cf_org: gsa-tts-oros-fac
+          cf_space: ${{ env.space }}
+          command: cf run-task gsa-fac -k 2G -m 2G --name historic_data_migrator --command "python manage.py historic-data-migrator --dbkeys ${{ inputs.dbkeys }} --years ${{ inputs.years }}"
diff --git a/backend/census_historical_migration/README.md b/backend/census_historical_migration/README.md
@@ -18,3 +18,9 @@ docker compose run web python manage.py historic_workbook_generator
 ```
 - `year` is optional and defaults to `22`.
 - The `output` directory will be created if it doesn't already exist.
+
+### How to trigger historic data migrator from GitHub:
+- Go to GitHub Actions and select `Historic data migrator` action
+- Next, click on `Run workflow` on top right and 
+- Provide the target `environment` along with optional parameters such as `dbkeys` and `years`
+- Click `Run`