{"id":24395184,"url":"https://github.com/RotorHazard/rhfest-action","last_synced_at":"2025-03-13T03:13:26.052Z","repository":{"id":271732093,"uuid":"914347680","full_name":"RotorHazard/rhfest-action","owner":"RotorHazard","description":"📋 GitHub Action that validates a RotorHazard plugin","archived":false,"fork":false,"pushed_at":"2025-03-03T21:13:31.000Z","size":101,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-03-07T02:54:08.462Z","etag":null,"topics":["actions","plugin","rotorhazard"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RotorHazard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-09T12:22:48.000Z","updated_at":"2025-03-03T21:13:34.000Z","dependencies_parsed_at":"2025-01-27T02:30:21.522Z","dependency_job_id":"0ba99495-ca24-4e24-8ca4-80575a1cfa6f","html_url":"https://github.com/RotorHazard/rhfest-action","commit_stats":null,"previous_names":["dutchdronesquad/rhfest-action","rotorhazard/rhfest-action"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RotorHazard%2Frhfest-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RotorHazard%2Frhfest-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RotorHazard%2Frhfest-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RotorHazard%2Frhfest-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RotorHazard","download_url":"https://codeload.github.com/RotorHazard/rhfest-action/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243330324,"owners_count":20274039,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","plugin","rotorhazard"],"created_at":"2025-01-19T20:26:25.804Z","updated_at":"2025-03-13T03:13:26.038Z","avatar_url":"https://github.com/RotorHazard.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RHFest Action\n\nA reusable GitHub Action that validates `manifest.json` files for RotorHazard plugins. It checks for missing fields, invalid formats, and unsupported values, and logs validation errors directly in GitHub Actions logs using **GitHub-friendly annotations**.\n\n## 🛠️ Features\n\n- ✅ Schema validation for `manifest.json`\n- ✅ Plugin repository structure validation\n- 🚨 GitHub Action annotations for validation errors\n- ⚠️ Warnings for missing required fields\n- 🐳 Docker image for local testing (manual or pre-commit)\n- 📋 Validates for example:\n  - **domain** format (e.g., lowercase letters, numbers, underscores)\n  - **version** [semver](https://semver.org) format (e.g., `X.Y.Z`)\n  - **dependencies** in `package==X.Y.Z` format\n  - **documentation_uri** URL format\n\n## 🚀 How to Use\n\nCreate a file `.github/workflows/validate.yml` in your plugin repository with the following content:\n\n```yaml\nname: Validate Plugin Manifest\n\non:\n  push:\n  pull_request:\n\njobs:\n  validate:\n    name: Run RHFest validation\n    runs-on: ubuntu-latest\n    steps:\n      - name: Check out repository\n        uses: actions/checkout@v4\n\n      - name: Run RHFest validation\n        uses: docker://ghcr.io/rotorhazard/rhfest-action:v2\n```\n\n## Test plugin locally\n\n_Needs Docker installed_\n\nRHFest is available as a [Docker image](https://github.com/RotorHazard/rhfest-action/pkgs/container/rhfest-action), which makes it easy to test locally without installing any dependencies. To test your RotorHazard plugin repository, you can use the following command:\n\n```bash\ndocker run --rm -v \"$(pwd)\":/repo ghcr.io/rotorhazard/rhfest-action:latest\n```\n\n## Development\n\nHow to setup the development environment.\n\n### Prerequisites\n\nYou need the following tools to get started:\n\n- [uv] - A python virtual environment/package manager\n- [Python] 3.13 - The programming language\n\n### Installation\n\n1. Clone the repository\n2. Install all dependencies with UV. This will create a virtual environment and install all dependencies\n\n```bash\nuv sync\n```\n\n3. Setup the pre-commit check, you must run this inside the virtual environment\n\n```bash\nuv run pre-commit install\n```\n\n4. Run the application\n\n```bash\nuv run python rhfest/core.py\n```\n\n### Run pre-commit checks\n\nAs this repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. You can run all checks and tests\nmanually, using the following command:\n\n```bash\nuv run pre-commit run --all-files\n```\n\nTo manual run only on the staged files, use the following command:\n\n```bash\nuv run pre-commit run\n```\n\n### Test Docker image\n\nTo build the Docker image locally, run the following command:\n\n```bash\ndocker build -t rhfest-action:latest .\n```\n\nTo run the Docker image, use the following command:\n\n```bash\ndocker run --rm -v \"$(pwd)\":/repo rhfest-action:latest\n```\n\n## 🌟 Credits\n\nThis project was inspired by:\n\n- Manifest validation in [HACS](https://hacs.xyz/)\n- Manifest validation (Hassfest) in [Home Assistant](https://www.home-assistant.io/)\n\n## License\n\nDistributed under the **MIT** License. See [`LICENSE`](LICENSE) for more information.\n\n\u003c!-- LINK --\u003e\n[uv]: https://docs.astral.sh/uv/\n[Python]: https://www.python.org/\n[pre-commit]: https://pre-commit.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRotorHazard%2Frhfest-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRotorHazard%2Frhfest-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRotorHazard%2Frhfest-action/lists"}