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

[Enhancement] add VSCode devcontainer configuration #116

Closed
ap00rv opened this issue Feb 9, 2021 · 6 comments
Closed

[Enhancement] add VSCode devcontainer configuration #116

ap00rv opened this issue Feb 9, 2021 · 6 comments
Assignees
Labels
blue enhancement New feature or request needs-triage This issue or PR still needs to be triaged.

Comments

@ap00rv
Copy link

ap00rv commented Feb 9, 2021

Is your feature request related to a problem? Please describe.
If someone wants to contribute to this project, they need to go through steps such as installing rust, pulling this repo and building it. Rust versions on each developer's machine may vary. We need a way to generate consistent, reproducible, version controlled and isolated dev environment.

Describe the solution you'd like
Add a /.devcontainer folder with necessary Dockerfile and .devcontainer.json

Describe alternatives you've considered
Alternative is installing prerequisites manually in a container.

Additional context
devcontainers are a great way to spin up dev environments with just one command. We can even kick off build as soon as the container is ready.
VSCode has good rust support via the official extension as well.

More on devcontainers here: https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume

@ap00rv ap00rv added the enhancement New feature or request label Feb 9, 2021
@ap00rv
Copy link
Author

ap00rv commented Feb 9, 2021

If the team can mention specific requirements for the dev environment, I am happy to take a stab at this. Thanks :)

@PatMyron
Copy link
Contributor

PatMyron commented Feb 9, 2021

also investigating https://www.gitpod.io/

@johnttompkins
Copy link
Contributor

Latest rust toolchain should suffice. We specify edition of rust in each package as well as dependencies here: https://github.com/aws-cloudformation/cloudformation-guard/blob/master/cfn-guard/Cargo.toml#L4, so i think as long as rust toolchain is up to date, package should be built the same way across platforms. This https://github.com/microsoft/vscode-remote-try-rust/blob/master/.devcontainer/devcontainer.json might be a good starting point?

@priyap286
Copy link
Contributor

priyap286 commented Jul 12, 2021

Hey @ap00rv

You can switch between different versions of Rust using rustup, more information can be found here and here. That being said we would be thrilled to accept your contribution if you would like to add devcontainer to cfn-guard. Do you need information other that that provided by @jotompki above?

@razcloud razcloud added the needs-triage This issue or PR still needs to be triaged. label May 12, 2022
@razcloud
Copy link
Contributor

@ap00rv Agree with your idea. We will research internally on how we will implement this. Thank you.

@razcloud razcloud added the blue label May 12, 2022
dannyvassallo added a commit that referenced this issue Apr 25, 2024
* uses bash atm - checking in to attempt zsh

* use ohmyzsh, add docs, add attribution

* typo

* Support bash AND zsh

* formatting
@dannyvassallo
Copy link
Contributor

@ap00rv this is now available - thanks for the suggestion!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blue enhancement New feature or request needs-triage This issue or PR still needs to be triaged.
Projects
None yet
Development

No branches or pull requests

6 participants