-
Notifications
You must be signed in to change notification settings - Fork 4
Documentation and local dev enhancements #30
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 hidden or 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,29 @@ | ||
| { | ||
| "name": "Pulumi Builder", | ||
| "image": "mcr.microsoft.com/devcontainers/base:ubuntu", | ||
| "features": { | ||
| "ghcr.io/devcontainers/features/go:1": {}, | ||
| "ghcr.io/guiyomh/features/golangci-lint:0": {}, | ||
| "ghcr.io/devcontainers/features/dotnet:2": {}, | ||
| "ghcr.io/devcontainers/features/python:1": {}, | ||
| "ghcr.io/devcontainers-community/npm-features/typescript:1": {}, | ||
| "ghcr.io/devcontainers/features/git:1": {}, | ||
| "ghcr.io/jungaretti/features/make:1": {}, | ||
| "ghcr.io/flexwie/devcontainer-features/pulumi:1": {}, | ||
| "ghcr.io/stuartleeks/dev-container-features/shell-history:0": {} | ||
| }, | ||
| "customizations": { | ||
| "vscode": { | ||
| "extensions": [ | ||
| "DavidAnson.vscode-markdownlint", | ||
| "bierner.markdown-preview-github-styles", | ||
| "esbenp.prettier-vscode", | ||
| "ms-vscode.makefile-tools", | ||
| "golang.go", | ||
| "github.vscode-github-actions", | ||
| "pulumi.pulumi-lsp-client" | ||
| ] | ||
| } | ||
| }, | ||
| "postCreateCommand": "${PWD}/.devcontainer/setup.sh" | ||
| } |
This file contains hidden or 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,97 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -eEo pipefail | ||
|
|
||
| # Create a temporary directory to download pulumictl | ||
| download_dir=$(mktemp -d) | ||
|
|
||
| # Cleanup function to remove the temporary directory | ||
| cleanup() { | ||
| local dir="${1}" | ||
| echo "Cleaning up download destination directory ${dir}" | ||
| rm -rf "${dir}" | ||
| } | ||
|
|
||
| # Set up trap to call cleanup on exit | ||
| trap 'cleanup "${download_dir}"' EXIT | ||
|
|
||
| # Function to get the latest release tag from pulumi/pulumictl | ||
| get_latest_pulumictl_release() { | ||
| local arch="${1:-amd64}" | ||
| local os="${2:-linux}" | ||
| curl -s https://api.github.com/repos/pulumi/pulumictl/releases/latest | \ | ||
| jq -r '.assets[] | | ||
| select(.browser_download_url | | ||
| test("pulumictl-.*'"${os}-${arch}"'.tar.gz")) | | ||
| .browser_download_url' | ||
| } | ||
|
|
||
| # Function to download the latest pulumictl release for a given OS and arch | ||
| # Usage: download_pulumictl_release <destination_dir> <os> <arch> | ||
| download_pulumictl_release() { | ||
| local dest_dir="$1" | ||
| local arch="${2:-amd64}" | ||
| local os="${3:-linux}" | ||
| local url | ||
| local filename | ||
|
|
||
| filename="pulumictl-${os}-${arch}.tar.gz" | ||
|
|
||
| url=$(get_latest_pulumictl_release "${arch}" "${os}") | ||
| if [[ -z "$url" ]]; then | ||
| echo "No pulumictl release found for ${os} ${arch}" | ||
| return 1 | ||
| fi | ||
|
|
||
| mkdir -p "${dest_dir}" | ||
| echo "Downloading pulumictl ${url} for ${os} ${arch}" | ||
| curl -s -L "${url}" -o "${dest_dir}/${filename}" | ||
| echo "Downloaded pulumictl to ${dest_dir}/${filename}" | ||
| } | ||
|
|
||
| get_os() { | ||
| local os | ||
| os=$(uname -s) | ||
| case $os in | ||
| Linux) echo "linux";; | ||
| Darwin) echo "darwin";; | ||
| *) echo "Unsupported OS: ${os}" >&2 ; return 1;; | ||
| esac | ||
| } | ||
|
|
||
| get_arch() { | ||
| local arch | ||
| arch=$(uname -m) | ||
| case $arch in | ||
| x86_64) echo "amd64";; | ||
| aarch64 | arm64) echo "arm64";; | ||
| *) echo "Unsupported architecture: ${arch}" >&2 ; return 1;; | ||
| esac | ||
| } | ||
|
|
||
| install_pulumictl() { | ||
| local dest_dir="${1}" | ||
| local os | ||
| local arch | ||
| local filename | ||
|
|
||
| if [[ -z "${dest_dir}" ]]; then | ||
| echo "Destination directory is required" | ||
| return 1 | ||
| fi | ||
|
|
||
| os=$(get_os) || return 1 | ||
| arch=$(get_arch) || return 1 | ||
|
|
||
| download_pulumictl_release "${dest_dir}" "${arch}" "${os}" | ||
|
|
||
| filename="pulumictl-${os}-${arch}.tar.gz" | ||
| echo "Extracting ${filename} to ${dest_dir}" | ||
| tar -xzf "${dest_dir}/${filename}" -C "${dest_dir}" | ||
| sudo mv "${dest_dir}/pulumictl" "/usr/local/bin/pulumictl" | ||
| sudo chmod +x "/usr/local/bin/pulumictl" | ||
| echo "Installed pulumictl to /usr/local/bin/pulumictl" | ||
| } | ||
|
|
||
| # Install pulumictl | ||
| install_pulumictl "${download_dir}" |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,10 @@ | ||
| name: esc-test | ||
| description: esc-test | ||
| runtime: | ||
| name: nodejs | ||
| options: | ||
| packagemanager: npm | ||
| config: | ||
| pulumi:tags: | ||
| value: | ||
| pulumi:template: typescript |
Oops, something went wrong.
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.
Is the idea of using setup.sh instead of a custom image that you want to pull the latest version every time? Or why not use a custom image?
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 didn't think it worth the effort to put that script into a whole separate custom feature. It's not likely to be very helpful to more than a small set of people. The
postCreateCommandis usually either a bunch of commands strung together for repo specific setup, or in a separate script, which I prefer from a readability standpoint.As for using a custom image, I think defeats the purpose of using devcontainer. This way, we can rebuild the devcontainer with the option to ignore the cache, and the base image and the feature layers get updated to what's current. If we used a custom image, there would be the need to keep it updated, hosting it, and so on.