Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces documentation for the Shell Plugin and updates the main README to reference the plugin’s source code directly.
- Added a complete README for the Shell Plugin detailing configuration, security considerations, and usage examples.
- Updated the main README to include a link to the Shell Plugin source file.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| plugins/shell/README.md | New documentation for the Shell Plugin with usage, configuration, and security guidelines. |
| README.md | Updated plugin table to include a direct link to the Shell Plugin source code. |
Comments suppressed due to low confidence (1)
plugins/shell/README.md:5
- [nitpick] Consider expanding the security note to include a brief recommendation on input sanitization or referencing a security best practices guide to help users mitigate risks.
⚠️ **Security Note:** Use with caution. Improperly configured shell commands can introduce security vulnerabilities. Always validate inputs and restrict command access where possible.
README.md
Outdated
| | ----------- | -------------------------------------- | -------------- | | ||
| | `ping` | Basic plugin used for testing | Sync or Async | | ||
| | `shell` | Shell command execution | Sync or Async | | ||
| | `shell` | [Shell command execution](https://github.com/patterninc/heimdall/blob/main/plugins/shell/shell.go) | Sync or Async | |
There was a problem hiding this comment.
[nitpick] Providing an absolute URL is helpful; consider using a relative link instead to ensure the reference remains valid in offline or different deployment scenarios.
wlggraham
approved these changes
May 14, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.