-
Notifications
You must be signed in to change notification settings - Fork 1
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
Add-badges-to-README.md #8
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
8e38b5a
Add all the badges.
sarg3nt 33cfde1
Remove codeql badge from README.md
sarg3nt 1d2601c
Fix viarious spelling errors in README.md
sarg3nt 60542a6
Imrpove README.md and fix some minor config issues in dev container
sarg3nt e368a79
Improve dev conatiner setup instructions and fix images.
sarg3nt 41224f4
Improve docs for dev.sh in README.md
sarg3nt 7e76c4c
More README.md improvements
sarg3nt 1183021
Add an install.sh file to make installing the .devcontainer and other…
sarg3nt c0af123
Update some examples.
sarg3nt 4cfd63f
Fix contributers section in README.md
sarg3nt 9674c68
Fix PR issues
sarg3nt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| #!/bin/bash | ||
| # | ||
| # This script will start the dev container and open an interactive prompt into it. | ||
| # | ||
|
|
||
| set -euo pipefail | ||
| IFS=$'\n\t' | ||
|
|
||
| # Check if user is using Docker Deskop for Windows or the native Docker Engine. | ||
| main() { | ||
| # shellcheck source=/dev/null | ||
| if [[ ! -f "usr/bin/lib/sh/colors.sh" ]]; then | ||
| echo "You do not appear to be in the go-dev-container project directory." | ||
| echo "This script must be ran from the root of the go-dev-container project directory." | ||
| exit 1 | ||
| fi | ||
| source "usr/bin/lib/sh/colors.sh" | ||
|
|
||
| local project_path="" | ||
| project_path="${1-}" | ||
| if [[ -z "${project_path}" ]]; then | ||
| echo -e "${RED}The path to your project was not passed in and is required.${NC}" | ||
| echo -e "${CYAN}Usage:${NC} $0 <path-to-your-project>" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Remove trailing slash from project_path if it exists | ||
| project_path="${project_path%/}" | ||
|
|
||
| if [[ ! -d "${project_path}" ]]; then | ||
| echo -e "${RED}The path to your project does not exist.${NC}" | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo -e "${BLUE}This script will copy the following directories and files into${NC} ${project_path}" | ||
| echo -e " .devcontainer" | ||
| echo -e " .mise.toml" | ||
| echo -e " cspell.json" | ||
| echo -e " dev.sh" | ||
| read -r -p "$(echo -e "${CYAN}Do you wish to continue? (y/n): ${NC}")" response | ||
| if [[ "$response" != "y" ]]; then | ||
| echo -e "${RED}Aborting.${NC}" | ||
| exit 1 | ||
| fi | ||
| echo "" | ||
|
|
||
| echo -e "${BLUE}Copying files to ${project_path}${NC}" | ||
|
|
||
| echo -e " ${GREEN}Copying${NC} .devcontainer ${GREEN}directory${NC}" | ||
| cp -r ".devcontainer" "${project_path}/" | ||
| echo -e " ${GREEN}Copying${NC} .mise.toml" | ||
| cp ".mise.toml" "${project_path}/" | ||
| echo -e " ${GREEN}Copying${NC} cspell.json" | ||
| cp "cspell.json" "${project_path}/" | ||
| echo -e " ${GREEN}Copying${NC} dev.sh" | ||
| cp "dev.sh" "${project_path}/" | ||
|
|
||
| echo "" | ||
| echo -e "${CYAN}You must now update the values in the${NC} ${project_path}/.devcontainer/devcontainer.json ${CYAN}and${NC} ${project_path}/dev.sh ${CYAN}files.${NC}" | ||
| echo -e "${CYAN}See${NC} README.md ${CYAN}for instructions.${NC}" | ||
|
|
||
| } | ||
|
|
||
| if ! (return 0 2>/dev/null); then | ||
| (main "$@") | ||
| fi |
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.
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.
Numbered steps were not incremented here.
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.
They are not supposed to be. This is Markdown best practice. The downstrem instance automatically numbers them correctly. This makes adding new items in random places and moving items around the list easier.