Skip to content

docs: add help text for cloud_storage_auditor metadata#678

Merged
utksh1 merged 2 commits into
utksh1:mainfrom
Nairayadav:issue-523-cloud-storage-helptext
Jun 10, 2026
Merged

docs: add help text for cloud_storage_auditor metadata#678
utksh1 merged 2 commits into
utksh1:mainfrom
Nairayadav:issue-523-cloud-storage-helptext

Conversation

@Nairayadav

Copy link
Copy Markdown
Contributor

Fixes #523

Changes

  • Added help text for the Search Query field in plugins/cloud_storage_auditor/metadata.json
  • Added help text for the Result Limit field
  • Clarified expected input format and usage for both fields
  • Refreshed the plugin checksum

Verification

  • Updated metadata successfully
  • Refreshed checksum using scripts/refresh_plugin_checksum.py
  • Verified JSON structure remains valid

@utksh1 utksh1 added level:beginner 20 pts difficulty label for small beginner-friendly PRs type:docs Documentation work category bonus label area:plugins Scanner plugin metadata, schemas, or plugin runtime work labels Jun 8, 2026

@utksh1 utksh1 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Backend tests are failing, so this cannot merge yet. Please rebase on latest main, regenerate the cloud_storage_auditor metadata checksum from the current plugin files, and make sure the parser output contract/backend test suite passes before requesting another review.

@Nairayadav Nairayadav force-pushed the issue-523-cloud-storage-helptext branch from 914f404 to 6067590 Compare June 9, 2026 07:41

@utksh1 utksh1 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-reviewed the latest push. Backend integration is still failing. Also keep metadata help-text PRs focused: no icon churn or unrelated checksum changes beyond the exact plugin metadata that changed. Please refresh checksum with the repo script and rerun checks.

@Nairayadav

Copy link
Copy Markdown
Contributor Author

Thanks for the re-review.

I've verified that the current diff is limited to the requested help-text additions and the corresponding checksum update for the plugin metadata. There are no icon changes or unrelated metadata modifications in the branch.

I also re-ran:

  • python scripts/refresh_plugin_checksum.py --plugin amass
  • python scripts/validate_plugins.py

The checksum refresh script reports the checksum is already up to date, and the full plugin validation passes successfully for all plugins.

The remaining failure appears to be in the backend integration/parser contract checks. If there is a specific backend test or additional validation step that I should run locally, please let me know and I'll investigate further.

@Nairayadav Nairayadav force-pushed the issue-523-cloud-storage-helptext branch from 6067590 to 46e7616 Compare June 10, 2026 08:02
@utksh1 utksh1 added the gssoc:approved Admin validation: approved for GSSoC scoring label Jun 10, 2026

@utksh1 utksh1 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved after maintainer cleanup. The PR is now focused on plugin field help text and the affected plugin checksum validates locally.

@utksh1 utksh1 merged commit 1128033 into utksh1:main Jun 10, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:plugins Scanner plugin metadata, schemas, or plugin runtime work gssoc:approved Admin validation: approved for GSSoC scoring level:beginner 20 pts difficulty label for small beginner-friendly PRs type:docs Documentation work category bonus label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[PLUGINS] Add field help text for cloud_storage_auditor metadata

2 participants