Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scheduled registry maintenance job #26

Open
DropSnorz opened this issue Nov 27, 2024 · 1 comment
Open

Scheduled registry maintenance job #26

DropSnorz opened this issue Nov 27, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@DropSnorz
Copy link

Create a monthly maintenance job using GitHub Action to check metadata and URL validity for the latest version of each package. The idea is to catch potential invalid digests or broken urls. Focusing on the latest version avoids revalidating the entire registry.

It's a feature I originally wanted to develop in owlplug-registry: OwlPlug/owlplug-registry#49

The maintenance job will check plugins, presets and projects fields:

  • audio - Validate url is not dead
  • files[*].url - Validate url is not dead
  • files[*].sha256 - Validate that the digest still match the file hash (relevant ? requires to download the full file)
  • image - Validate that url is not dead (and image meet some size criterias like max size ?)
  • url - Validate that url is not dead

The report can be published as a Github issue.

Message Value Manifest
🚫 Invalid return code 500 for url https://github.com/airwindows/airwindows/archive/refs/heads/master.zip plugins/airwindows/airwindows/1.0.0/index.yaml
Invalid return code 404 for audio https://open-audio-stack.github.io/open-audio-stack-registry/plugins/airwindows/airwindows/airwindows.flac plugins/airwindows/airwindows/1.0.0/index.yaml
@kmturley
Copy link
Member

Bonne idee!

The GitHub Action in validate.yml already does some of this work:
https://github.com/open-audio-stack/open-audio-stack-registry/blob/main/.github/workflows/validate.yml

Likely whatever monthly validation should also be done on PRs. So we can share the same code. Just run at different times.

The current Action only scans files that have changed. Could create a duplicate Action without the changed files step.
Adding a schedule cron timing: https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#schedule

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

2 participants