How to interpret VoronUsers CI results
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.ymlfile - Checking that all files you specified in your
.metadata.ymlfile 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 one of the following 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 (see Step 2) and fix them -
Warning: CI Error: Something went wrong while performing automated checks. The github team will investigate and update you on the situation.
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) with a check summary.
In this summary, the following 4 outcomes are possible:
-
✅ SUCCESS: This check has executed successfully -
⚠️ WARNING: This check has triggered a warning. This does not mean that something has to be fixed. Please check the warning details to determine if you should act. -
❌ ERROR: This check has failed. This means that your PR does have issues (e.g. corrupt STL file, bad/missing metadata file, etc.). Please check the detailed error messages. -
💀 EXCEPTION: This check failed in an unexpected way. Please check the error message to determine whether this is an issue on your end. If not, the Github team will work with you to get this check resolved.
Below is an example for a pull request comment summary. Note the three marked sections and their descriptions below:
- Here you can see the mods that were detected by the CI
- 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.
- Detailed results for each result type. Click the arrow on the left to expand the list and check the errors the CI detected
In the given example, the CI has failed, because two exceptions (one for STL corruption check and one for STL rotation check) were triggered. By expanding the EXCEPTION section at the bottom, we can find details about the check exceptions:
As you can see, in both cases main_body_rainbow_A.stl caused an exception because the STL is not readable by the tools. The next course of action for the submitter is to examine the file, create a fix and update the PR accordingly.
Further, our PR has also triggered some warnings. By expanding the WARNING section we can check them out:
As we can see, the rotation checker suggested new orientations, however, since they are obviously worse than the ones we submitted to this PR, we can safely ignore them.