Pull Request Validation Error - File not Found (Module)


Issue

When executing a PR Validation in GitHub on a new change (https://docs.armory.io/docs/armory-admin/dinghy-enable/#pull-request-validations), users are unable to validate the execution. 

If users run ARM-CLI (https://github.com/armory-io/arm) locally to validate the dinghyfile and modules, it returns no errors.

When executing the PR Validation, there is an error about File Not Found on the modules

Cause

Executing a PR that includes a change to the dinghyfile along with a change to modules (addition of them or removal of them) causes the failure.  This is because the PR validation is validating against the repo structure of the module files in the master branch at the time of execution.  

Because the modules are being added at the same time as the dinghyfile, they are "missing" because they do not already exist in the structure

Solution

Armory will be looking to make changes to the PR Validator for GitHub.  For now, when adding modules as a part of your PR request, it is best to use the following steps:
 

  1. Make a PR for all module changes only and execute them first to add them into GitHub
  2. Make a PR for the dinghyfile change and execute to allow the validator to check and validate the changes


To check against these changes currently, it's recommended to run the arm-cli checker in tandem with the Validator to ensure there are no issues https://github.com/armory-io/arm

Validator is currently being improved upon and there are adjustments being made to the function.  Once they have been implemented, this article will advise of the changes.

As Tested On Version

2.21.x