Skip to content

Commit

Permalink
Merge pull request #10 from YevhenBondarenko/feature/validator-descri…
Browse files Browse the repository at this point in the history
…ption
  • Loading branch information
ashvayka authored Sep 28, 2024
2 parents 36a9bab + 57cc03f commit 6a95063
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,18 @@ We encourage you to contribute by creating a Pull Request (PR) for this reposito

If you encounter any issues creating a Pull Request, you may alternatively create a [public gist](https://gist.github.com/) with the necessary files and submit a GitHub issue containing the link to your gist.

Once submitted, our team will review the request and run manual and automated tests. After the PR is merged, it may take up to 24 hours for the new converter to be available in existing ThingsBoard instances.
Once you create a PR, our automated validation workflow will be triggered. This workflow checks that all uplink and downlink converters are valid by running the provided payloads through the corresponding converters.

If the validation passes, the PR will be marked as successful, and our team will review the request, performing additional manual and automated tests. After the PR is merged, it may take up to 24 hours for the new converter to become available in existing ThingsBoard instances.

## What to do if validation fails?

If your validation fails (**the workflow is marked with a red cross**) click on the workflow name **Validate Data Converters** to view the detailed logs and identify the issues.

For example, you may encounter a message like this:

`Validation failed for VENDORS/Milesight/AM307/ChirpStack/uplink with payload payload.json and result result.json. Expected output does not match.`

This error indicates that the result.json file does not match the actual output generated by the converter when processing the provided payload.json.

To resolve this issue, update your result.json file or modify the converter logic as necessary. After making the required changes, push your updates to the same branch. The validation workflow will automatically re-run and re-check your PR.

0 comments on commit 6a95063

Please sign in to comment.