Skip to content

[Enhancement] add VSCode devcontainer configuration  #116

Closed

Description

@ap00rv

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

Activity

  1. ap00rv commented on Feb 9, 2021

    @ap00rv
    Author

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

  2. PatMyron commented on Feb 9, 2021

    @PatMyron
    Contributor

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

  3. johnttompkins commented on Feb 15, 2021

    @johnttompkins
    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?

  4. priyap286 commented on Jul 12, 2021

    @priyap286
    Contributor

    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?

  5. razcloud commented on May 12, 2022

    @razcloud
    Contributor

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

  6. dannyvassallo commented on Apr 25, 2024

    @dannyvassallo
    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

Metadata

Metadata

Assignees

Labels

blueenhancementNew feature or requestneeds-triageThis issue or PR still needs to be triaged.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions