Update README from JSON (source)

These changes will update the README from JSON file using GitHub actions. The JSON file becomes the source of data for the README. The README will be updated automatically when the JSON file is updated. The JSON file will be used to generate the README file using a python script. The python script will be run using GitHub actions.

Author: Khalilsqu

.github/workflows/update_readme.yml

@@ -0,0 +1,68 @@
+name: Update README from JSON
+# This workflow automatically updates the README file whenever the JSON file or the script changes.
+on:
+  push:
+    paths:
+      - "awesome_open_geoscience.json" # JSON file in root directory
+      - "scripts/json_to_readme.py" # Python script
+      - "scripts/order.txt" # Order file
+      - "media/**" # Anything in 'media' folder
+  workflow_dispatch: # Allows manual triggering in GitHub Actions UI
+    inputs:
+      update_readme:
+        type: boolean
+        required: false
+        default: false
+  # schedule:
+  #   - cron: "0 0 * * 0" # Weekly on Sundays at midnight UTC
+
+  workflow_run:
+    # This workflow will run after the "Validate JSON Entries" workflow is completed
+    workflows: ["Validate JSON Entries"]
+    types: [completed]
+    branches:
+      - main
+
+jobs:
+  update-readme:
+    # run only if the previous workflow run was successful or if manually triggered
+    # This is to prevent the README update from running if the JSON validation fails
+    if: >
+      (github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success') ||
+      (github.event_name == 'workflow_dispatch' && github.event.inputs.update_readme == 'true')
+
+    runs-on: ubuntu-latest
+    # Grant write permissions to the GITHUB_TOKEN
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: pip install pyyaml
+
+      - name: Generate README
+        run: python scripts/json_to_readme.py awesome_open_geoscience.json scripts/order.txt
+
+      - name: Check for changes
+        id: git-check
+        run: |
+          git diff --quiet README.md || echo "changes=true" >> $GITHUB_OUTPUT
+
+      - name: Commit and push changes
+        if: steps.git-check.outputs.changes == 'true'
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git add README.md
+          git commit -m "Auto-update README from JSON [skip ci]" || echo "No changes to commit"
+          # Use GITHUB_TOKEN for authentication
+          git push "https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git" HEAD:main

.github/workflows/validate_json.yml

@@ -0,0 +1,32 @@
+name: Validate JSON Entries
+description: Validate JSON entries in awesome_open_geoscience.json
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "awesome_open_geoscience.json"
+  pull_request:
+    paths:
+      - "awesome_open_geoscience.json"
+  workflow_dispatch:
+
+jobs:
+  check-entries:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: pip install jsonschema
+
+      - name: Validate JSON Entries
+        run: |
+          python scripts/validate_json_entries.py awesome_open_geoscience.json

.lycheeignore

@@ -1,7 +1,7 @@
 https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fsoftwareunderground%2Fawesome-open-geoscience
 https://geoscience.data.qld.gov.au
 https://opensource.org/license/lgpl-license-html
-https://opensource.org/licenses/gpl-license 
+https://opensource.org/licenses/gpl-license
 https://reproducibility.org/wiki/Installation
 https://wiki.seg.org/wiki/Open_data
 https://www.gnu.org/licenses/license-list.html#NonFreeDocumentationLicenses
@@ -16,3 +16,4 @@ http://www.fsf.org/licensing/licenses/
 https://www.fsf.org/licensing/licenses/
 https://www.gnu.org/licenses/
 http://www.gnu.org/licenses/
+https://researchportal.hw.ac.uk/en/datasets/costa-model-hierarchical-carbonate-reservoir-benchmarking-case-st