Skip to content

build: add recommended config files for VSCode remote development - #30450

Closed
gkalpak wants to merge 2 commits into
angular:masterfrom
gkalpak:build-config-remote-dev
Closed

gkalpak wants to merge 2 commits into
angular:masterfrom
gkalpak:build-config-remote-dev

Conversation

@gkalpak

@gkalpak gkalpak commented May 14, 2019

Copy link
Copy Markdown
Member

Add some recommended config files to use (as is or as basis) for setting up remote development using docker containers with VSCode. This is an opt-in feature. See .devcontainer/README.md for more info.

The configuration can be further tweaked/improved, but is a good starting point.

@gkalpak gkalpak added action: merge The PR is ready for merge by the caretaker area: build & ci Related the build and CI infrastructure of the project effort2: days target: patch This PR is targeted for the next patch release risk: low labels May 14, 2019
@gkalpak
gkalpak requested a review from IgorMinar as a code owner May 14, 2019 08:57
@gkalpak
gkalpak requested a review from a team May 14, 2019 08:57
@ngbot ngbot Bot modified the milestone: needsTriage May 14, 2019
Add some recommended config files to use (as is or as basis) for setting
up [remote development using docker containers][1] with VSCode. This is
an opt-in feature. See `.devcontainer/README.md` for more info.

The configuration can be further tweaked/improved, but is a good
starting point.

[1]: https://code.visualstudio.com/docs/remote/containers
@gkalpak
gkalpak force-pushed the build-config-remote-dev branch from 4caa0f1 to 6af62c3 Compare May 14, 2019 08:59
@@ -0,0 +1,22 @@
# Image metadata and config.
FROM circleci/node:10-browsers

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

WDYT of eventually moving to a non-circleci image? These have some specific circleci stuff going on and it would be less surprising to use the official images.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Definitely an option. The good thing about the CircleCI ones is that they set up things to run in a headless container environment (e.g. installing Chrome and creating an alias that runs with the necessary flags to work inside a container, installing Xvfb and setting it up to automatically start when running the container, etc.). Plus, it will be similar with our CI environment.

All of this could be replicated independently (that's what I tried to do initially). But at some point I thought that if I'm re-implementing many of their stuff, I could as well use their image 😁

"dockerFile": "Dockerfile",
"appPort": [4000, 4200, 4433, 5000, 8080, 9876],
"postCreateCommand": "yarn install",
"extensions": [

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Are all these mandatory? If I read the reference correctly they will all be installed. But these aren't the ones listed in https://github.com/angular/angular/blob/master/.vscode/extensions.json.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yeah, I was unsure about that. The two extra extensions are eslint and Angular Language Service. These are mostly useful for aio development.
I was pondering adding them to the recommended extensions, but since many people will only be developing outside aio/ I left them out.

Happy to remove them.
Maybe I can comment them out and mention that these are useful if you are working on aio/.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I commented them out.
I, also, added them in .vscode/extension.json (also commented out, so they won't be recommended, but if someone looks inside the file they will see them).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think that makes sense. To be honest we're going to run more into this problem (optional extensions) as we further add more to the monorepo.

@gkalpak gkalpak closed this May 14, 2019
@gkalpak gkalpak reopened this May 14, 2019
@alxhub alxhub added the action: review The PR is still awaiting reviews from at least one requested reviewer label May 14, 2019
@IgorMinar IgorMinar added merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels May 17, 2019
@IgorMinar

Copy link
Copy Markdown
Contributor

merge-assistance: codefresh is flaky

@jasonaden jasonaden closed this in f78bda9 May 20, 2019
jasonaden pushed a commit that referenced this pull request May 20, 2019
…0450)

Add some recommended config files to use (as is or as basis) for setting
up [remote development using docker containers][1] with VSCode. This is
an opt-in feature. See `.devcontainer/README.md` for more info.

The configuration can be further tweaked/improved, but is a good
starting point.

[1]: https://code.visualstudio.com/docs/remote/containers

PR Close #30450
BioPhoton pushed a commit to BioPhoton/angular that referenced this pull request May 21, 2019
…gular#30450)

Add some recommended config files to use (as is or as basis) for setting
up [remote development using docker containers][1] with VSCode. This is
an opt-in feature. See `.devcontainer/README.md` for more info.

The configuration can be further tweaked/improved, but is a good
starting point.

[1]: https://code.visualstudio.com/docs/remote/containers

PR Close angular#30450
@gkalpak
gkalpak deleted the build-config-remote-dev branch May 21, 2019 13:11
@angular-automatic-lock-bot

Copy link
Copy Markdown

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot Bot locked and limited conversation to collaborators Sep 15, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

action: merge The PR is ready for merge by the caretaker area: build & ci Related the build and CI infrastructure of the project cla: yes effort2: days merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note risk: low target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants