Add configValidation to DattoRMM plugin #46
+11
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| { | ||
| "steps": [ | ||
| { | ||
| "displayName": "Datto RMM connection", | ||
| "dataStream": { "name": "importSites", "timeframe": "none" }, | ||
| "success": "Successfully connected to Datto RMM", | ||
| "error": "Cannot connect to Datto RMM — check your Base URL, API Key and API Secret", | ||
| "required": true | ||
| } | ||
| ] | ||
| } | ||
|
Check failure on line 11 in plugins/DattoRMM/v1/configValidation.json
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔴 This PR adds a new file inside the plugin directory (
plugins/DattoRMM/v1/configValidation.json) but does not bump theversionfield inplugins/DattoRMM/v1/metadata.json(still1.0.1). Per repo conventions, any change inside a plugin directory must include a version bump so users receive the update on their next plugin refresh — please bump it (e.g. to1.0.2).Extended reasoning...
What the bug is
The PR introduces a new file
plugins/DattoRMM/v1/configValidation.jsonto add a connection-test step for the Datto RMM plugin. However, the accompanyingplugins/DattoRMM/v1/metadata.jsonstill has"version": "1.0.1", unchanged from before. The repository's review conventions explicitly require that any diff touching files inside a plugin directory include a corresponding version bump inmetadata.json.How it manifests / why the existing code doesn't prevent it
Plugin distribution systems typically use the
versionfield inmetadata.jsonas the trigger to deliver updated plugin assets to end users on refresh. Without a version bump, the validation pipeline still passes (as seen in the bot's summary comment showingConfig Validation: true), and the new file is technically present in the repo, but downstream consumers who already have the plugin at1.0.1will see no version change and may not pick up the newconfigValidation.jsonon their next refresh. The validation tooling checks structural correctness of the new file but does not enforce the version-bump convention, so this slips through CI.Impact
End users of the Datto RMM plugin will not receive the new connection-test step — defeating the entire purpose of this PR — even though the file is merged. The feature is effectively dark until the version is bumped in a follow-up commit.
How to fix
In
plugins/DattoRMM/v1/metadata.json, change line 4 from"version": "1.0.1"to"version": "1.0.2"(or a higher appropriate semver) and include that change in this PR.Step-by-step proof
plugins/DattoRMM/v1/configValidation.json(new file, 11 lines). No other files are modified.plugins/DattoRMM/v1/configValidation.jsonresides inside the plugin directoryplugins/DattoRMM/v1/.plugins/DattoRMM/v1/metadata.jsonat line 4 shows"version": "1.0.1"— unchanged.