From 40488f7440760c321d60fbfe58336b55839035b1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Erik=20Bj=C3=A4reholt?= <erik@bjareho.lt>
Date: Tue, 3 Oct 2023 10:15:03 +0200
Subject: [PATCH] ci: added CI job for updating README.md

---
 .github/workflows/build.yml | 33 +++++++++++++++++++++++++++++++++
 README.md.in                |  6 +++---
 data.yaml                   |  3 +++
 3 files changed, 39 insertions(+), 3 deletions(-)
 create mode 100644 .github/workflows/build.yml

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
new file mode 100644
index 0000000..22b924f
--- /dev/null
+++ b/.github/workflows/build.yml
@@ -0,0 +1,33 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  readme:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Generate README
+        run: python generate_readme.py
+
+      - name: Commit and push changes
+        run: |
+          git config --global user.name 'GitHub Actions'
+          git config --global user.email 'github-actions@example.com'
+          git add README.md
+          git commit -m "chore: automatically generated README.md"
+          git push origin master
diff --git a/README.md.in b/README.md.in
index 2ef8783..36da290 100644
--- a/README.md.in
+++ b/README.md.in
@@ -15,7 +15,7 @@ Current trends and state of the art for using open & local LLM models as copilot
 
 📝 *Help keep this list relevant and up-to-date by [making edits][edit]!*
 
-[edit]: https://github.com/ErikBjare/are-copilots-local-yet/edit/master/README.md
+[edit]: https://github.com/ErikBjare/are-copilots-local-yet/edit/master/data.yaml
 
 ## 📋 Summary
 
@@ -79,7 +79,7 @@ Models relevant for local Copilot-use. Ordered by most recent first.
 
 | Name                            | Size       | Languages   | :star:  | Released   | Notes                                                                    |
 | ------------------------------- | ---------- | ----------- | ------- | ---------- | -------                                                                  |
-{% for item in models %}| [{{ item.name }}]({{ item.link }}) | {{ item.size }} | {{ item.languages | join(", ") }} | {{ item.stars }} | {{ item.released }} | {{ item.notes }} |
+{% for item in models %}| [{{ item.name }}]({{ item.link }}) | {{ item.size }} | {{ item.languages }} | {{ item.stars }} | {{ item.released }} | {{ item.notes }} |
 {% endfor %}
 
 **Note:** due to the pace of new model releases, this section is doomed to be out of date.
@@ -90,7 +90,7 @@ Datasets relevant for training models.
 
 | Name                            | Size                   | Languages   | :star:  | Released   | Notes                                                       |
 | ------------------------------- | ----------             | ----------- | ------- | ---------- | -------                                                     |
-{% for item in datasets %}| [{{ item.name }}]({{ item.link }}) | {{ item.size }} | {{ item.languages | join(", ") }} | {{ item.stars }} | {{ item.released }} | {{ item.notes }} |
+{% for item in datasets %}| [{{ item.name }}]({{ item.link }}) | {{ item.size }} | {{ item.languages }} | {{ item.stars }} | {{ item.released }} | {{ item.notes }} |
 {% endfor %}
 
 ## Tools
diff --git a/data.yaml b/data.yaml
index f46f18e..202fa91 100644
--- a/data.yaml
+++ b/data.yaml
@@ -1,3 +1,6 @@
+# This file contains all the tools presented in the README.
+# Add a tool to the appropriate section, then the CI will rebuild the README.
+
 extensions:
   - name: "GitHub Copilot"
     editor: ["VSCode", "vim"]