Skip to content

Automated validation

Mihail Anton edited this page Jun 24, 2020 · 4 revisions

Implementation

First, choose a workflow framework that makes the validation process easy to follow. The options were maestrowf and Sake, because pyInvoke looked dead. However, GitHub has a way to create a dynamic matrix, so it is better to use this instead.

Implement the steps below locally:

  1. Use the GitHub API to find all repositories that have the topic standard-GEM and are not named standard-GEM
  2. For each repository found:
  • using GH raw, download the .standard-GEM.md file from each release and the develop branch
  • for each downloaded file, compare with the standard-GEM releases
  • comparison should be done by diff, with the only differences being changes from [ ] to [x]. Other differences should be seen as not matching the standard.

The output should be saved in a format that is easy to parse - useful when presenting the status on a website.
Lastly, migrate the workflow to a GH Actions workflow.