generated from cisagov/ScubaGear
-
Notifications
You must be signed in to change notification settings - Fork 29
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
Update setup process and instructions #613
Open
adhilto
wants to merge
42
commits into
main
Choose a base branch
from
531-update-setup-instructions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nd to respect the nocheck parameter
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🗣 Description
Modified the installation process and documentation per feedback.
Coauthered by @atuomit.
Goals of these changes:
.scubagoggles
should be a directory and this config should be a file under that directory. The current config file should also be a file under that directory. #526.Specific changes:
scubagoggles gws
💭 Motivation and context
Closes #526.
Closes #531.
🧪 Testing
I recommend the reviewers start by following the README instructions as a new user would, specifically the 3 files listed under the "Installation" section of the README: https://github.com/cisagov/ScubaGoggles/blob/531-update-setup-instructions/README.md.
If you already have ScubaGoggles installed, first move the .scubagoggles file from your home directory. Since that was a text file and now is a folder, you will need to first move it before you can use the new setup util.
I performed the following tests:
✅ Pre-approval checklist
✅ Pre-merge Checklist
Squash and merge
button.✅ Post-merge Checklist