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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document OPA Path changes + add back ScubaGear root directory as possible place for OPA exe location #835

Open
1 task
buidav opened this issue Jan 22, 2024 · 0 comments 路 May be fixed by #1092
Open
1 task
Assignees
Labels
enhancement This issue or pull request will add new or improve existing functionality
Milestone

Comments

@buidav
Copy link
Collaborator

buidav commented Jan 22, 2024

馃挕 Summary

$OPAPath parameter in Invoke-SCuBA was changed to accommodate for the upcoming case of installing ScubaGear from PSGallery.
The default path was changed to Join-Path -Path $env:USERPROFILE -ChildPath ".scubagear\Tools. A folder to be created under the user's home folder.

This issue is to add back in the original path Join-Path -Path $PSScriptRoot -ChildPath "..\..\.." as a fallback path in case the above path does not exist due to mkdir failure or the user is using the zip packaged release.

Another thing that needs to be updated is the documentation in the README for OPA default path and the docstring above Invoke-SCuBA

Motivation and context

The original intent for the default $OPAPath was so that a user could set up ScubaGear and start running with minimal installation troubleshooting. This issue is to reinforce that with documentation and additional fallbacks in case something goes awry.

Implementation notes

  • Add the original Join-Path -Path $PSScriptRoot -ChildPath "..\..\.." as a fallback default path to $OPAPath in Invoke-SCuBA.
  • Update documentation in the README specifically Download the Required OPA Executable and $OPAPath under Parameter Definitions
  • Update the $OPAPath docstring above Invoke-SCuBA to document the new path changes.

Acceptance criteria

  • A PR with the implementation notes above are made and merged into main.
@buidav buidav added the enhancement This issue or pull request will add new or improve existing functionality label Jan 22, 2024
@buidav buidav changed the title Document OPA Path changes + add back ScubaGear root directory as possible place for OPA Document OPA Path changes + add back ScubaGear root directory as possible place for OPA exe location Jan 22, 2024
@cisagov cisagov deleted a comment Jan 23, 2024
@schrolla schrolla added this to the Glacier milestone Jan 29, 2024
@buidav buidav self-assigned this Mar 27, 2024
@buidav buidav modified the milestones: Glacier, Halibut Mar 27, 2024
@buidav buidav linked a pull request May 7, 2024 that will close this issue
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants