Skip to content
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

Save parameters to json file #551

Open
wants to merge 2 commits into
base: 519-policy-api-updates
Choose a base branch
from
Open

Save parameters to json file #551

wants to merge 2 commits into from

Conversation

aormu
Copy link
Collaborator

@aormu aormu commented Jan 3, 2025

🗣 Description

Save ScubaGoggles Parameters/config to JSON output.

Save configuration to a JSON file.

💭 Motivation and context

This enables users to review the parameters utilized to operate this tool in the future.

Save the parameters value in a JSON file.

🧪 Testing

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • If applicable, All future TODOs are captured in issues, which are referenced in the PR description.
  • The relevant issues PR resolves are linked preferably via closing keywords.
  • All relevant type-of-change labels have been added.
  • I have read and agree to the CONTRIBUTING.md document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated to reflect the changes in this PR.
  • Tests have been added and/or modified to cover the changes in this PR.
  • All new and existing tests pass.

✅ Pre-merge Checklist

  • This PR has been smoke tested to ensure main is in a functional state when this PR is merged.
  • Squash all commits into one PR level commit using the Squash and merge button.

✅ Post-merge Checklist

  • Delete the branch to clean up.
  • Close issues resolved by this PR if the closing keywords did not activate.

@aormu aormu requested a review from adhilto January 3, 2025 14:49
@adhilto adhilto added this to the Driftwood milestone Jan 6, 2025
@adhilto adhilto changed the title save parameter to json file Save parameters to json file Jan 6, 2025
Copy link
Collaborator

@adhilto adhilto left a comment

Choose a reason for hiding this comment

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

A few things:

  1. Sorry this wasn't detailed in the issued, but for consistency with ScubaGear, the parameters shouldn't be saved as a separate json file. They should be saved in the primary ScubaResults.json file, in the Raw section, under the sub-key scuba_config.
  2. The Pylinter is reporting several issues that should be resolved before merging: https://github.com/cisagov/ScubaGoggles/actions/runs/11691841759/job/32559891620?pr=551
  3. There are several merge conflicts. I know @rlxdev offered to help with any merge conflicts, you might ask him for help if you need it. I'm happy to help as well.
  4. Please describe what testing you performed in the "Testing" section of the pull request description.

@adhilto adhilto modified the milestones: Driftwood, Eel Jan 7, 2025
@rlxdev rlxdev changed the base branch from main to 519-policy-api-updates January 9, 2025 18:03
@rlxdev rlxdev force-pushed the 519-policy-api-updates branch from 484e88d to 67abc58 Compare January 9, 2025 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants