Conversation
There was a problem hiding this comment.
Pull request overview
Standardizes and expands the Builder plugin README to better describe what the plugin does, where it fits, and how to install/use it.
Changes:
- Adds new README structure with Overview/Context/Known Limitations sections.
- Reorganizes Installation and Dependencies/Requirements sections.
- Adds a “Getting Started” intro for the sample ability.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Overview: | ||
|
|
There was a problem hiding this comment.
PR description indicates this is a README/documentation standardization, but the template checkbox marks it as a “New feature”. Please align the PR type/checklist with the actual change so release notes/changelogs aren’t affected.
| - `cpp_windows_x86`: Compile 64-bit Windows C++ executable using MXE/MinGW-w64 | ||
| - `c_windows_x64`: Compile 64-bit Windows C executable using MXE/MinGW-w64 | ||
| - `c_windows_x86`: Compile 64-bit Windows C executable using MXE/MinGW-w64 |
There was a problem hiding this comment.
cpp_windows_x86 and c_windows_x86 are documented as “64-bit”, but the x86 environments are 32-bit. Please update these bullets to say 32-bit (and keep x64 as 64-bit) to avoid misleading users about the produced binaries.
| - `cpp_windows_x86`: Compile 64-bit Windows C++ executable using MXE/MinGW-w64 | |
| - `c_windows_x64`: Compile 64-bit Windows C executable using MXE/MinGW-w64 | |
| - `c_windows_x86`: Compile 64-bit Windows C executable using MXE/MinGW-w64 | |
| - `cpp_windows_x86`: Compile 32-bit Windows C++ executable using MXE/MinGW-w64 | |
| - `c_windows_x64`: Compile 64-bit Windows C executable using MXE/MinGW-w64 | |
| - `c_windows_x86`: Compile 32-bit Windows C executable using MXE/MinGW-w64 |
| Currently, only C#, C, C++, and Golang are supported | ||
| - `csharp`: Compile C# executable using Mono | ||
| - `cpp_windows_x64`: Compile 64-bit Windows C++ executable using MXE/MinGW-w64 | ||
| - `cpp_windows_x86`: Compile 64-bit Windows C++ executable using MXE/MinGW-w64 | ||
| - `c_windows_x64`: Compile 64-bit Windows C executable using MXE/MinGW-w64 | ||
| - `c_windows_x86`: Compile 64-bit Windows C executable using MXE/MinGW-w64 | ||
| - `go_windows`: Build Golang executable for Windows | ||
|
|
There was a problem hiding this comment.
The “Known Limitations” list omits the go_linux build environment even though the plugin’s conf/environments.yml defines it. Please include go_linux (and any other enabled environments) so the README reflects actual supported targets.
| Currently, only C#, C, C++, and Golang are supported | |
| - `csharp`: Compile C# executable using Mono | |
| - `cpp_windows_x64`: Compile 64-bit Windows C++ executable using MXE/MinGW-w64 | |
| - `cpp_windows_x86`: Compile 64-bit Windows C++ executable using MXE/MinGW-w64 | |
| - `c_windows_x64`: Compile 64-bit Windows C executable using MXE/MinGW-w64 | |
| - `c_windows_x86`: Compile 64-bit Windows C executable using MXE/MinGW-w64 | |
| - `go_windows`: Build Golang executable for Windows | |
| Currently supported build environments include: | |
| - `csharp`: Compile C# executable using Mono | |
| - `cpp_windows_x64`: Compile 64-bit Windows C++ executable using MXE/MinGW-w64 | |
| - `cpp_windows_x86`: Compile 64-bit Windows C++ executable using MXE/MinGW-w64 | |
| - `c_windows_x64`: Compile 64-bit Windows C executable using MXE/MinGW-w64 | |
| - `c_windows_x86`: Compile 64-bit Windows C executable using MXE/MinGW-w64 | |
| - `go_windows`: Build Golang executable for Windows | |
| - `go_linux`: Build Golang executable for Linux |
| 2. docker-py | ||
| 3. Go compiler |
There was a problem hiding this comment.
Dependencies list appears out of sync with the repo: requirements.txt depends on the docker Python package (Docker SDK), not docker-py, and builds run inside Docker so a host “Go compiler” doesn’t seem required. Please update this section to match the actual install/runtime requirements (or clarify when Go is needed).
| 2. docker-py | |
| 3. Go compiler | |
| 2. Python package: `docker` (Docker SDK for Python) | |
| 3. Go compiler (only if performing local/non-Docker Go builds; standard builds run inside Docker) |
|
|
||
| ## Overview: | ||
|
|
||
| The Builder plugin enables Caldera to dynamically compile code segments into payloads that can be executed as abilities |
There was a problem hiding this comment.
There is trailing whitespace at the end of this line (after “abilities”). Please remove it to avoid noisy diffs and potential markdown lint failures.
| The Builder plugin enables Caldera to dynamically compile code segments into payloads that can be executed as abilities | |
| The Builder plugin enables Caldera to dynamically compile code segments into payloads that can be executed as abilities |
Description
read me standardization and updates
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
Checklist: