-
Notifications
You must be signed in to change notification settings - Fork 3.4k
feat: Declare a DevContainer for easy onboarding #11844
Conversation
I haven't heard of this feature of VSCode, but it seems useful. We should probably support a full set of VS Code options/extensions similar to Angular and Angular Components. However, we would need to add some Markdown documentation for both contributing with VS Code and separately, using the DevContainer. For now, I'm going to target this at the |
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.
We'll need to add a section about this in the developer guide found at docs/guides/BUILD.md
.
@Splaktar That seems reasonable. The last time I checked that guide, I got the impression that it was abandoned, because they mention Should I add a new section about DevContainer usage at the bottom and then maybe create a new ticket to review and correct the guide? |
I added some documentaiton to the guide, although a lot of it is just describing the DevContainer feature in general. I tried to not duplicate too much. Users who use the extension or plan to use it, will likely educate themselves through the official documentation to an extent that they don't require a lot of introduction into the specifics in this project, as there are almost none. I've also since added the default LiveReload port of gulp-connect to the forwarded ports, which now enabled the livereload feature as well when using the DevContainer. |
It's not abandoned and issues should be filed if it's not accurate. I've gone through and refreshed most of these, but this one does look like it needs a lot of attention. Thank you for the heads up.
Yes, please. |
- update release script to update version in `package-lock.json` Relates to #11844
- release script updates version in `package-lock.json` - remove unused `release.sh` script - start tagging docs snapshots and releases - use more consistent release commit messages and git commands - improve release script log messages Relates to #11844
- release script updates version in `package-lock.json` - remove unused `release.sh` script - start tagging docs snapshots and releases - use more consistent release commit messages and git commands - improve release script log messages Relates to #11844
DevContainers are a feature of VS Code: https://code.visualstudio.com/docs/remote/containers They allow us to declare a development environment that is independent from the developers workstation. This allows us to easily work in a Node <12 environment, regardless of the Node version installed on the developers workstation.
I integrated a lot of the CircleCI stuff and cleaned it up. Full test suite can be run in the container now. |
DevContainers are a feature of VS Code: https://code.visualstudio.com/docs/remote/containers
They allow us to declare a development environment that is independent from the developers workstation. This allows us to easily work in a Node <12 environment, regardless of the Node version installed on the developers workstation.
PR Checklist
Please check that your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
AngularJS Material requires NodeJS <12 for development. Developers may already be using NodeJS 12+.
What is the new behavior?
Developers will get the ability to easily work on AngularJS Material in a defined environment, given that they meet the requirements to use the VS Code DevContainers feature.
Does this PR introduce a breaking change?