Workflow Updates (sdr-enthusiasts#373)

* Update Workflows to run properly. * fix typlo * Actually include the template... * Remove unneeded files/script. * reference create script in worfklow path * reference correct script in worfklow path * Remove twitter blocked from workflows * Linting and logging on update_readme.py. * reference update_readme.py vs update_readme.yml
Phaeton · Oct 30, 2023 · c77bd12 · c77bd12
1 parent 1b91273
commit c77bd12
Show file tree

Hide file tree

Showing 14 changed files with 186 additions and 70,849 deletions.
diff --git a/.github/workflows/create_db_derivatives.yaml b/.github/workflows/create_db_derivatives.yaml
@@ -8,7 +8,6 @@ on:
     branches: ["main"]
     paths:
       - "plane-alert-db.csv"
-      - "plane-alert-twitter-blocked.csv"
       - "plane-alert-ukraine.csv"
       - "plane_images.csv"
       - "scripts/create_db_derivatives.py"
@@ -29,6 +28,9 @@ jobs:
       - name: Create category and images derivative CSV files
         run: python ./scripts/create_db_derivatives.py
 
+      - name: Update README.md to include changes
+        run: python ./scripts/update_readme.py
+
       - name: Commit derivative CSV files
         uses: stefanzweifel/git-auto-commit-action@v5
         with:

diff --git a/.github/workflows/update_readme.yml b/.github/workflows/update_readme.yml
@@ -4,14 +4,18 @@ permissions:
   contents: write # Allow action to write back changes to repository.
 
 on:
-  workflow_run:
-    workflows: [Create derivative databases]
-    types:
-      - completed
-    branches: [main]
+  push:
+    branches: ["main"]
+    paths:
+      - "scripts/update_readme.py"
+      - "readme.mustache"
+      - "!plane-alert-db.csv"
+      - "!plane-alert-ukraine.csv"
+      - "!plane_images.csv"
+      - "!scripts/create_db_derivatives.py"
 
 jobs:
-  on-success:
+  updateREADME:
     if: github.repository == 'sdr-enthusiasts/plane-alert-db' || ${{ vars.CREATE_DERIVATIVES }}
     name: Update README.md documentation for Changes
     runs-on: ubuntu-latest

diff --git a/_bin/README.md b/_bin/README.md
diff --git a/_bin/badgers-best-images.csv b/_bin/badgers-best-images.csv
diff --git a/_bin/badgers-best.csv b/_bin/badgers-best.csv
diff --git a/_bin/plane-alert-db-images.csv b/_bin/plane-alert-db-images.csv
diff --git a/_bin/plane-alert-db.csv b/_bin/plane-alert-db.csv
diff --git a/_bin/plane-alert-pia.csv b/_bin/plane-alert-pia.csv
diff --git a/_bin/plane-alert-search-terms-to-do.csv b/_bin/plane-alert-search-terms-to-do.csv
diff --git a/_bin/plane-alert-wip.csv b/_bin/plane-alert-wip.csv
diff --git a/_bin/planepix.txt b/_bin/planepix.txt
diff --git a/scripts/README.md b/scripts/README.md
@@ -4,6 +4,6 @@ This folder contains several scripts used in the GitHub actions:
 
 - `check_james_planes`: A script that can be used to check if the planes mentioned in https://github.com/sdr-enthusiasts/plane-alert-db/issues/24 are already in the main databases.
 - `check_main_databases`: A script that is used to check whether the main databases are correctly formatted.
-- `create_db_derivatives`: A script that can be used to create the derivative databases based on the `plane-alert-db.csv`, `plane_images.csv` and `blacklist.txt` files.
-- `create_images_reference`: A tiny little script that I used to create the new `plane_images.csv` file. This file will be removed when we are sure the file of the new image is correct.
+- `create_db_derivatives`: A script that can be used to create the derivative databases based on the `plane-alert-db.csv` and `plane_images.csv` files.
 - `get_unique_bangers_best_items`: A script that can be used to check if the `bangers-best.csv` database contains items not found in the main databases.
+- `update_readme`: A script that can be used to automate the README.md updates using the mustache template language and the chevron parser.
diff --git a/scripts/create_images_reference.py b/scripts/create_images_reference.py