diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 34fb776..9f0ebc8 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -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 diff --git a/README.md b/README.md new file mode 100644 index 0000000..0314197 --- /dev/null +++ b/README.md @@ -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.