chore: add readme, remove public dir, use PAT in workflow

This commit is contained in:
dyzulk
2026-01-19 16:05:11 +07:00
parent 8d5548c73f
commit 6c7a1ccf1e
2 changed files with 25 additions and 1 deletions

View File

@@ -32,7 +32,7 @@ jobs:
- name: Generate Registry & Releases
run: php scripts/generate_registry.php
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GH_PAT }}
# Upload the 'public' folder as an artifact for Pages
- name: Upload artifact

24
README.md Normal file
View File

@@ -0,0 +1,24 @@
# Mivo Plugin Registry
This repository hosts the **Plugin Registry** for the Mivo Hotspot System.
## How it Works
This repository uses **GitHub Actions** to automatically scan the `mivodev` organization for repositories starting with `plugin-`. It then generates a JSON index (`plugins.json`) and a release archive (`releases.json`).
The generated artifacts are deployed to **GitHub Pages** and serve as the backend for the Mivo Plugin Store.
## API Endpoints
- **Plugins Index**: `https://mivodev.github.io/registry/plugins.json`
- **Releases Index**: `https://mivodev.github.io/registry/releases.json`
## Automation
The workflow is defined in `.github/workflows/deploy.yml`. It runs:
1. **Daily** at midnight.
2. **Manually** via Workflow Dispatch.
3. **On Push** to the `main` branch.
**Requirements:**
- A valid `GH_PAT` (Personal Access Token) with `repo` and `read:org` scopes must be configured in the Organization Secrets to allow the script to fetch repository details.