Skip to content

How to interpret VoronUsers CI results

Florian Heilmann edited this page Dec 19, 2023 · 6 revisions

Intro

In the new VoronUsers, we use an extensive set of automated checks to check the contents of your submitted mod.

These include:

  • Checking all files and folders for whitespace
  • Checking whether all mods have a .metadata.yml file
  • Checking that all files you specified in your .metadata.yml file are actually present
  • Checking if there are any files outside of your mod folder you may have committed by accident
  • Check that submitted STLs are not corrupt (this uses the same mechanism as PrusaSlicer to check your files for errors)
  • Perform a rotation check on your STLs (this tool is experimental, therefore you can ignore these errors after double-checking the results)

The result of the CI will be indicated with a label on your PR:

  • CI: Passed: Congratulations, all checks have executed successfully
  • CI: Issues identified: The automated checks have identified issues with your submission, please check the results in the comment and fix them
  • 'Warning: CI Error`: Something went wrong while performing automated checks. The github team will investigate and update you on the situation.

PR comment

Upon completion of the CI, you will receive a comment in your pull request (this comment is updated everytime you make changes to your PR and the CI runs)

image

  1. Here you can see the mods that were detected by the CI
  2. Here you can see an overview of the results. Green checkmarks and Orange warnings are okay (though you should still check the warnings), while red errors and exceptions will cause the CI to fail.
  3. Detailed results for each result type. Click the arrow on the left to expand the list and check the errors the CI detected
Clone this wiki locally