-
Notifications
You must be signed in to change notification settings - Fork 209
feat: Add custom guidance and appendices support #475
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Add custom guidance and appendices support #475
Conversation
|
Thanks for the contribution! Unfortunately we can't verify the commit author(s): Leona Magaya <l***@t***.com>. One possible solution is to add that email to your GitHub account. Alternatively you can change your commits to another email and force push the change. After getting your commits associated with your GitHub account, sign the Salesforce Inc. Contributor License Agreement and this Pull Request will be revalidated. |
- Add TemplateConfig class to detect and process custom HTML files - Support custom-guidance.html and custom-appendices.html in project root - Implement dynamic navigation with conditional tab visibility - Add Vue components for custom content rendering with v-html - Include comprehensive test coverage for all scenarios - Update documentation with usage examples and behavior guide
68f03cf to
68d9b92
Compare
|
@leonamagaya sorry for the delay. I looked at this now and tried it out. It looks great! Thanks for contributing. Running the tests. Once it passes I'm good to merge and approve. |
|
looks like the linting failed. Can you run the tests on your end locally to make sure they pass first so we don't have to wait for the PR checks to fail? Once they pass on your end we can re-run and hopefully be good to merge. |
|
@kmcquade Thank you for having a look. Let me run the tests and report back. |
5d7d535 to
08e9080
Compare
|
@leonamagaya yeah sometimes that happens due to Policy Sentry's data source being updated - when Salesforce updates the AWS documentation with new actions. If you could fix those that would be fantastic |
|
@kmcquade the failing tests were caused by a Windows-specific issue with the I ran the tests using WSL and all 83 tests passed successfully. Therefore we do not need to make any changes. It is good to go if you agree.
|


What does this PR do?
This PR adds support for customizable guidance and appendices content in Cloudsplaining HTML reports. Users can now provide their own HTML content files to customize the guidance and appendices sections of their reports.
Key features:
custom-guidance.htmlandcustom-appendices.htmlfiles in their working directoryHow to use this feature
Use Case 1: Custom Guidance Content
Result: Report shows your custom guidance content instead of default AWS guidance.
Use Case 2: Custom Appendices with Additional Resources
Result: Report shows custom appendices content instead of default AWS appendices
Use Case 3: Hide Sections Completely
Result: No Guidance or Appendices tabs appear in the navigation
Use Case 4: Mixed Configuration
Result: Custom guidance tab + default AWS appendices tab
Use Case 5: Default Behavior (No Changes)
# Don't create any custom files - works exactly as before cloudsplaining scan --input-file default.json --output reports/Result: Standard AWS guidance and appendices content (existing behavior)
File Requirements
custom-guidance.htmlandcustom-appendices.htmlcloudsplaining scancommandWhat gif best describes this PR or how it makes you feel?
Completion checklist
make test,make lint,make security-test,make test-js)