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

feat(devcontainer): devcontainer setup #1086

Merged
merged 2 commits into from
Oct 15, 2023
Merged

Conversation

Azanul
Copy link
Collaborator

@Azanul Azanul commented Oct 12, 2023

Problem

Some new contributors face issues when setting up their environment for the first time

Solution

Adds a devcontainer config file. This can be used to spawn a devcontainer locally or a GitHub codespace with

How to Test

Try to create a devcontainer using VS code extension or try creating a GitHub codespace.

Checklist

  • Code follows the contributing guidelines
  • Changes have been thoroughly tested
  • Documentation has been updated, if necessary
  • Any dependencies have been added to the project, if necessary

Signed-off-by: Azanul <azanulhaque@gmail.com>
Copy link
Collaborator

@mlabouardy mlabouardy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great addition :)

// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/go
{
"name": "Go",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should name it something general

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to suggest names

},
"customizations": {
"vscode": {
"extensions": [
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about those who use a non-vscode env ;) Like me

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This config works with GH Codespaces and VSCode with devcontainers extension. If you use something that has devcontainer support then it'll probably have it's own customizations. Jetbrains has a guide to it.
If you doubt that vscode extensions part might interfere with the spawning devcontainer, I don't think it will but you're welcome to test it out.

What do you use?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point from @AvineshTripathi. I'm on SublimeText and nvim.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know that neovim has devcontainer support, don't know if SublimeText does or not.
As I said, the respective tools will have their own customizations. I know how to mention the same for vscode & codespaces but not for other tools.

Copy link
Collaborator

@mlabouardy mlabouardy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll merge this PR, but we can open additional PRs to extend it to other IDEs.

@mlabouardy mlabouardy added this to the v3.1.2 milestone Oct 15, 2023
@mlabouardy mlabouardy merged commit e9cdfd6 into tailwarden:develop Oct 15, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants