Skip to content

The definitive list of the best of (consumer facing) open source.

Add PR checks

Lucas38ba1995b432
diff --git a/.github/workflows/generate-readme.yml b/.github/workflows/generate-readme.yml
index 005c93c..c21b306 100644
--- a/.github/workflows/generate-readme.yml
+++ b/.github/workflows/generate-readme.yml
@@ -2,8 +2,16 @@ name: Generate README
on:
workflow_dispatch:
- schedule:
- - cron: "0 1 * * *"
+ push:
+ branches:
+ - main
+ paths:
+ - "core/components/**"
+ - "core/source/generation/**"
+ - "core/data/static/categories.json"
+ - "core/data/static/platforms.json"
+ - "core/data/static/tags.json"
+ - "core/data/static/archive.json"
jobs:
generate:
@@ -38,8 +46,9 @@ jobs:
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
- git add tests/test.md
git add ../resources/readmes/
git add ../README.md
git diff --quiet && git diff --staged --quiet || git commit -m "Generate READMEs"
+ git pull --rebase
git push
+
diff --git a/.github/workflows/pr-validation.yml b/.github/workflows/pr-validation.yml
new file mode 100644
index 0000000..3a1203a
--- /dev/null
+++ b/.github/workflows/pr-validation.yml
@@ -0,0 +1,68 @@
+name: Pull Request Validation
+
+on:
+ pull_request:
+ branches:
+ - main
+ push:
+ branches:
+ - main
+ workflow_dispatch:
+
+permissions:
+ contents: read
+
+jobs:
+ validate-core:
+ name: Validate Core & Data Integrity
+ runs-on: ubuntu-latest
+ defaults:
+ run:
+ working-directory: core
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v6
+
+ - name: Install UV
+ uses: astral-sh/setup-uv@v7
+
+ - name: Set up Python
+ run: uv python install
+
+ - name: Install project and dev dependencies
+ run: uv sync --dev
+
+ - name: Run linter (ruff)
+ run: uv run ruff check .
+
+ - name: Run unit tests
+ run: uv run python -m unittest discover -s tests
+
+ - name: Validate data files and JSON format
+ run: uv run source/maintenance/json_formatter.py
+
+ validate-web-client:
+ name: Validate Web Client
+ runs-on: ubuntu-latest
+ defaults:
+ run:
+ working-directory: apps/web-client
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v6
+
+ - name: Set up Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: 22
+
+ - name: Install dependencies
+ run: npm ci
+
+ - name: Check types
+ run: npm run type-check
+
+ - name: Build web client
+ run: npm run build-only
diff --git a/.github/workflows/update-stats.yml b/.github/workflows/update-stats.yml
index a3d6c08..4940095 100644
--- a/.github/workflows/update-stats.yml
+++ b/.github/workflows/update-stats.yml
@@ -4,6 +4,11 @@ on:
workflow_dispatch:
schedule:
- cron: "0 0 * * *" # Every day at midnight UTC
+ push:
+ branches:
+ - main
+ paths:
+ - "core/data/static/applications.json"
permissions:
contents: write
@@ -36,10 +41,17 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: uv run source/maintenance/stats_updator.py
+ - name: Run README generator script
+ run: uv run source/generation/readme_generator.py
+
- name: Commit changes
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add data/dynamic/applications_generated.json
- git commit -m "Auto-update GitHub metadata" || echo "No changes to commit"
+ git add ../resources/readmes/
+ git add ../README.md
+ git diff --quiet && git diff --staged --quiet || git commit -m "Auto-update applications metadata and READMEs"
+ git pull --rebase
git push
+
diff --git a/README.md b/README.md
index 8061ba0..c082267 100644
--- a/README.md
+++ b/README.md
@@ -1972,7 +1972,6 @@ Projects that were once on this list but removed, usually due to abandonment or
- [Maestral](https://github.com/samschott/maestral) - `Archived`
- [File Browser](https://github.com/filebrowser/filebrowser) - `Archived`
- [Airweave](https://github.com/airweave-ai/airweave) - `Archived`
- - [Maestral](https://github.com/samschott/maestral) - `Archived`
- [Papermerge DMS](https://github.com/ciur/papermerge) - `Archived`
</details>
diff --git a/core/data/static/applications.json b/core/data/static/applications.json
index fc9080e..ddb74b6 100644
--- a/core/data/static/applications.json
+++ b/core/data/static/applications.json
@@ -988,7 +988,7 @@
"license": ""
},
{
- "name": "Tabby",
+ "name": "TabbyML",
"description": "",
"repo_url": "https://github.com/TabbyML/tabby",
"tags": [],
@@ -1645,7 +1645,7 @@
"license": ""
},
{
- "name": "Zen",
+ "name": "Zen Browser",
"description": "",
"repo_url": "https://github.com/zen-browser/desktop",
"tags": [],
@@ -10564,7 +10564,7 @@
"license": ""
},
{
- "name": "quill",
+ "name": "Quill Transcription",
"description": "",
"repo_url": "https://github.com/digimata/quill",
"tags": [],
diff --git a/core/data/static/archive.json b/core/data/static/archive.json
index 94b1283..806e830 100644
--- a/core/data/static/archive.json
+++ b/core/data/static/archive.json
@@ -165,11 +165,6 @@
"repo_url": "https://github.com/airweave-ai/airweave",
"reason": "archived"
},
- {
- "name": "Maestral",
- "repo_url": "https://github.com/samschott/maestral",
- "reason": "archived"
- },
{
"name": "Papermerge DMS",
"repo_url": "https://github.com/ciur/papermerge",
diff --git a/core/data/static/categories.json b/core/data/static/categories.json
index c8bc463..6a85860 100644
--- a/core/data/static/categories.json
+++ b/core/data/static/categories.json
@@ -836,12 +836,6 @@
"parent": "other",
"description": ""
},
- {
- "name": "Time Management",
- "id": "time-management",
- "parent": "productivity",
- "description": ""
- },
{
"name": "Mapping",
"id": "mapping",
diff --git a/resources/PORTAL.md b/resources/PORTAL.md
index 9348812..361a9c1 100644
--- a/resources/PORTAL.md
+++ b/resources/PORTAL.md
@@ -24,8 +24,9 @@ The place that connects everything related to definitive-opensource.
- [tags](/core/data/static/tags.json) - Declares tags, their id, and corresponding emoji
## GitHub Actions
+- [pr-validation.yml](/.github/workflows/pr-validation.yml) - Validates pull requests (linting, unit tests, and JSON format integrity)
- [generate-readme.yml](/.github/workflows/generate-readme.yml) - Calls the [`readme_generator.py`](/core/source/generation/readme_generator.py) to generate READMEs
-- [update-stats.yml](/.github/workflows/update-stats.yml) - Calls the [`stats_updator.py`](/core/source/maintenance/stats_updator.py.py) to update stats in applications.json
+- [update-stats.yml](/.github/workflows/update-stats.yml) - Calls [`stats_updator.py`](/core/source/maintenance/stats_updator.py) to update stats and generate READMEs
## Other Resources
- [DOCS.md](/resources/DOCS.md) - Elaborates tags
diff --git a/resources/maintenance/format_maintenance.md b/resources/maintenance/format_maintenance.md
index fab8755..fe252ae 100644
--- a/resources/maintenance/format_maintenance.md
+++ b/resources/maintenance/format_maintenance.md
@@ -1,24 +1,3 @@
# Format Maintenance Report
-## applications.json
-
-### Tabby
-- Duplicate application name
-
-### Zen
-- Duplicate application name
-
-### quill
-- Duplicate application name
-
-## categories.json
-
-### Time Management
-- Duplicate subcategory ID 'time-management'
-
-## archive.json
-
-### Maestral
-- Duplicate application name
-- Duplicate GitHub URL
-
+No issues found. All data files are properly formatted.
diff --git a/resources/readmes/linux.md b/resources/readmes/linux.md
index 1c68f9a..6a77a46 100644
--- a/resources/readmes/linux.md
+++ b/resources/readmes/linux.md
@@ -1428,7 +1428,6 @@ Projects that were once on this list but removed, usually due to abandonment or
- [Maestral](https://github.com/samschott/maestral) - `Archived`
- [File Browser](https://github.com/filebrowser/filebrowser) - `Archived`
- [Airweave](https://github.com/airweave-ai/airweave) - `Archived`
- - [Maestral](https://github.com/samschott/maestral) - `Archived`
- [Papermerge DMS](https://github.com/ciur/papermerge) - `Archived`
</details>
diff --git a/resources/readmes/macos.md b/resources/readmes/macos.md
index bc119a3..68f08d9 100644
--- a/resources/readmes/macos.md
+++ b/resources/readmes/macos.md
@@ -1503,7 +1503,6 @@ Projects that were once on this list but removed, usually due to abandonment or
- [Maestral](https://github.com/samschott/maestral) - `Archived`
- [File Browser](https://github.com/filebrowser/filebrowser) - `Archived`
- [Airweave](https://github.com/airweave-ai/airweave) - `Archived`
- - [Maestral](https://github.com/samschott/maestral) - `Archived`
- [Papermerge DMS](https://github.com/ciur/papermerge) - `Archived`
</details>
diff --git a/resources/readmes/selfhost.md b/resources/readmes/selfhost.md
index 9dc4f83..f397d5b 100644
--- a/resources/readmes/selfhost.md
+++ b/resources/readmes/selfhost.md
@@ -1010,7 +1010,6 @@ Projects that were once on this list but removed, usually due to abandonment or
- [Maestral](https://github.com/samschott/maestral) - `Archived`
- [File Browser](https://github.com/filebrowser/filebrowser) - `Archived`
- [Airweave](https://github.com/airweave-ai/airweave) - `Archived`
- - [Maestral](https://github.com/samschott/maestral) - `Archived`
- [Papermerge DMS](https://github.com/ciur/papermerge) - `Archived`
</details>
diff --git a/resources/readmes/windows.md b/resources/readmes/windows.md
index 4870600..a685fa6 100644
--- a/resources/readmes/windows.md
+++ b/resources/readmes/windows.md
@@ -1425,7 +1425,6 @@ Projects that were once on this list but removed, usually due to abandonment or
- [Maestral](https://github.com/samschott/maestral) - `Archived`
- [File Browser](https://github.com/filebrowser/filebrowser) - `Archived`
- [Airweave](https://github.com/airweave-ai/airweave) - `Archived`
- - [Maestral](https://github.com/samschott/maestral) - `Archived`
- [Papermerge DMS](https://github.com/ciur/papermerge) - `Archived`
</details>