Moved readme updater

.github/read_metadata.py

@@ -0,0 +1,30 @@
+import os
+import json
+
+
+def readMetadata(src_path, gh_link="", metadata_file_name="metadata.json"):
+    notes_metadata = {}
+
+    # Reads courses metadata
+    for root, _, files in os.walk(src_path):
+        if metadata_file_name in files:
+            with open(os.path.join(root, metadata_file_name)) as f:
+                metadata = json.load(f)
+                dir_name = os.path.relpath(root, src_path)
+                gh_path = os.path.join(gh_link, dir_name)
+                
+                if metadata["year"] not in notes_metadata: notes_metadata[metadata["year"]] = {}
+                if metadata["semester"] not in notes_metadata[metadata["year"]]: notes_metadata[metadata["year"]][metadata["semester"]] = {}
+
+                notes_metadata[metadata["year"]][metadata["semester"]][metadata["name"]] = {
+                    "name": metadata["name"],
+                    "content": [
+                        {
+                            "name": pdf["name"],
+                            "url": os.path.join(gh_path, pdf["path"])
+                        }
+                        for pdf in metadata["pdfs"]
+                    ]
+                }
+
+    return notes_metadata

.github/update_readme.py

@@ -0,0 +1,30 @@
+import argparse
+from read_metadata import readMetadata
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(prog="README updater")
+    parser.add_argument("--src-path", type=str, required=True, help="Path to the .tex sources")
+    parser.add_argument("--readme-path", type=str, required=True, help="Path to the readme")
+    parser.add_argument("--gh-link", type=str, required=True, help="Link to the GitHub repo")
+    args = parser.parse_args()
+
+    notes_metadata = readMetadata(args.src_path, args.gh_link)
+
+    # Appends links to README
+    with open(args.readme_path, "a") as readme_f:
+        readme_f.write(f"\n\n## Table of contents\n")
+        for year in sorted(notes_metadata.keys()):
+            readme_f.write(f"\n### Year {year}\n")
+
+            for semester in sorted(notes_metadata[year].keys()):
+                for course in sorted(notes_metadata[year][semester]):
+                    course_name = notes_metadata[year][semester][course]["name"]
+                    course_content = notes_metadata[year][semester][course]["content"]
+
+                    if (len(course_content) == 1) and (course_content[0]["name"] is None):
+                        readme_f.write(f"- [**{course_name}**]({course_content[0]['url']})\n")
+                    else:
+                        readme_f.write(f"- **{course_name}**\n")
+                        for content in course_content:
+                            readme_f.write(f"   - [{content['name']}]({content['url']})\n")

.github/workflows/compile.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches:
       - main
-    paths: ["src/**", .github/workflows/**, compile.sh]
+    paths: ["src/**", .github/**, compile.sh]
 
 jobs:
   compile:
@@ -32,17 +32,20 @@ jobs:
 
       - name: Prepare output directory
         run: |
-          mkdir .compiled
-          cp LICENSE .compiled
+          mkdir ${GITHUB_WORKSPACE}/.compiled
+          cp ${GITHUB_WORKSPACE}/LICENSE ${GITHUB_WORKSPACE}/.compiled
 
       - name: Compile
         run: |
-          bash ./utils/compile.sh src .compiled .currpdfs
+          bash ${GITHUB_WORKSPACE}/utils/compile.sh src ${GITHUB_WORKSPACE}/.compiled ${GITHUB_WORKSPACE}/.currpdfs
 
       - name: Generate README
         run: |
           cp README.md .compiled/README.md
-          python3 ./utils/update_readme.py --src-path ./src --readme-path .compiled/README.md --gh-link https://github.com/NotXia/unibo-ai-notes/blob/pdfs
+          python3 ${GITHUB_WORKSPACE}/.github/update_readme.py \
+            --src-path ${GITHUB_WORKSPACE}/src \
+            --readme-path ${GITHUB_WORKSPACE}/.compiled/README.md \
+            --gh-link https://github.com/NotXia/unibo-ai-notes/blob/pdfs
 
 
       - name: Move to pdfs branch