-
Notifications
You must be signed in to change notification settings - Fork 13
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
Make it so that the scubagoggles reports link to the baselines #323
base: main
Are you sure you want to change the base?
Make it so that the scubagoggles reports link to the baselines #323
Conversation
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.
Overall looks great. Just one small thing.
Co-authored-by: Alden Hilton <106177711+adhilto@users.noreply.github.com>
β¦ file, similar to ScubaGear
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.
Nice work. Just one final piece, I didn't notice this before but the spaces in the URLs are not properly encoded.
For example, instead of this:
https://github.com/cisagov/scubagoggles/tree/v0.2.0/baselines/Google Meet Minimum Viable Secure Configuration Baseline v0.2.md#4-External-Participants
The links should look like this:
https://github.com/cisagov/ScubaGoggles/blob/v0.2.0/baselines/Google%20Meet%20Minimum%20Viable%20Secure%20Configuration%20Baseline%20v0.2.md#4-External-Participants
scubagoggles/reporter/reporter.py
Outdated
group_reference_url = f'{SCUBA_GITHUB_URL}/blob/v0.2.0/baselines/'\ | ||
f'{full_name} Minimum Viable Secure Configuration Baseline v0.2.md#'\ |
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.
perhaps pull both v0.2.0's
out into their own variable?
This will make refactoring easier in the future for version bumps.
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.
I went ahead and added variables for the baseline and tool versions for the URL
π£ Description
Make it so that the control group names in the report are links to their respective groups in the baseline.
Closes #200
Closes #312
π Motivation and context
Feature already present in ScubaGear. Nice to have feature, making it easier for users to learn more about the controls.
π§ͺ Testing
Run ScubaGoggles to ensure HTML reports are created correctly with proper URL links for group titles.
Ensure that group reference URLs for control groups are included in ScubaResults.json file.
β Pre-approval checklist
β Pre-merge Checklist
Squash and merge
button.β Post-merge Checklist