Update template, add info on features and image metadata (#51)
* Update template, add info on features and image metadata * Typo * Remove redundant README note * Language correction
This commit is contained in:
		@@ -1,24 +0,0 @@
 | 
				
			|||||||
# See here for image contents: https://github.com/microsoft/vscode-dev-containers/blob/main/containers/java/.devcontainer/base.Dockerfile
 | 
					 | 
				
			||||||
# [Choice] Java version (use -bullseye variants on local arm64/Apple Silicon): 8, 11, 17, 8-bullseye, 11-bullseye, 17-bullseye, 8-buster, 11-buster, 17-buster
 | 
					 | 
				
			||||||
ARG VARIANT=11-bullseye
 | 
					 | 
				
			||||||
FROM mcr.microsoft.com/devcontainers/java:${VARIANT}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
# [Option] Install Maven
 | 
					 | 
				
			||||||
ARG INSTALL_MAVEN="false"
 | 
					 | 
				
			||||||
ARG MAVEN_VERSION=""
 | 
					 | 
				
			||||||
# [Option] Install Gradle
 | 
					 | 
				
			||||||
ARG INSTALL_GRADLE="false"
 | 
					 | 
				
			||||||
ARG GRADLE_VERSION=""
 | 
					 | 
				
			||||||
RUN if [ "${INSTALL_MAVEN}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/sdkman/bin/sdkman-init.sh && sdk install maven \"${MAVEN_VERSION}\""; fi \
 | 
					 | 
				
			||||||
    && if [ "${INSTALL_GRADLE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/sdkman/bin/sdkman-init.sh && sdk install gradle \"${GRADLE_VERSION}\""; fi
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
 | 
					 | 
				
			||||||
ARG NODE_VERSION="none"
 | 
					 | 
				
			||||||
RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
# [Optional] Uncomment this section to install additional OS packages.
 | 
					 | 
				
			||||||
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
 | 
					 | 
				
			||||||
#     && apt-get -y install --no-install-recommends <your-package-list-here>
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
# [Optional] Uncomment this line to install global node packages.
 | 
					 | 
				
			||||||
# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
 | 
					 | 
				
			||||||
@@ -1,19 +1,16 @@
 | 
				
			|||||||
// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at:
 | 
					// For format details, see https://aka.ms/devcontainer.json. For config options, see the
 | 
				
			||||||
// https://github.com/microsoft/vscode-dev-containers/tree/v0.195.0/containers/java
 | 
					// README at: https://github.com/devcontainers/templates/tree/main/src/java
 | 
				
			||||||
{
 | 
					{
 | 
				
			||||||
	"name": "Java",
 | 
						"name": "Java",
 | 
				
			||||||
	"build": {
 | 
						// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
 | 
				
			||||||
		"dockerfile": "Dockerfile",
 | 
						"image": "mcr.microsoft.com/devcontainers/java:0-17",
 | 
				
			||||||
		"args": {
 | 
					
 | 
				
			||||||
			// Update the VARIANT arg to pick a Java version: 8, 11, 17
 | 
						"features": {
 | 
				
			||||||
			// Append -bullseye or -buster to pin to an OS version.
 | 
							"ghcr.io/devcontainers/features/java:1": {
 | 
				
			||||||
			// Use the -bullseye variants on local arm64/Apple Silicon.
 | 
								"version": "none",
 | 
				
			||||||
			"VARIANT": "17-bullseye",
 | 
								"installMaven": "true",
 | 
				
			||||||
			// Options
 | 
								"mavenVersion": "3.8.6",
 | 
				
			||||||
			"INSTALL_MAVEN": "true",
 | 
								"installGradle": "false"
 | 
				
			||||||
			"MAVEN_VERSION": "3.8.5",
 | 
					 | 
				
			||||||
			"INSTALL_GRADLE": "false",
 | 
					 | 
				
			||||||
			"NODE_VERSION": "lts/*"
 | 
					 | 
				
			||||||
		}
 | 
							}
 | 
				
			||||||
	},
 | 
						},
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -21,17 +18,12 @@
 | 
				
			|||||||
	"customizations": {
 | 
						"customizations": {
 | 
				
			||||||
		// Configure properties specific to VS Code.
 | 
							// Configure properties specific to VS Code.
 | 
				
			||||||
		"vscode": {
 | 
							"vscode": {
 | 
				
			||||||
			// Set *default* container specific settings.json values on container create.
 | 
								"settings": {},
 | 
				
			||||||
			"settings": { 
 | 
					 | 
				
			||||||
				"maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn"
 | 
					 | 
				
			||||||
			},
 | 
					 | 
				
			||||||
			
 | 
					 | 
				
			||||||
			// Add the IDs of extensions you want installed when the container is created.
 | 
					 | 
				
			||||||
			"extensions": [
 | 
								"extensions": [
 | 
				
			||||||
				"vscjava.vscode-java-pack"
 | 
									"streetsidesoftware.code-spell-checker"
 | 
				
			||||||
			]
 | 
								]
 | 
				
			||||||
		}
 | 
							}
 | 
				
			||||||
	},
 | 
						}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 | 
						// Use 'forwardPorts' to make a list of ports inside the container available locally.
 | 
				
			||||||
	// "forwardPorts": [],
 | 
						// "forwardPorts": [],
 | 
				
			||||||
@@ -39,6 +31,6 @@
 | 
				
			|||||||
	// Use 'postCreateCommand' to run commands after the container is created.
 | 
						// Use 'postCreateCommand' to run commands after the container is created.
 | 
				
			||||||
	// "postCreateCommand": "java -version",
 | 
						// "postCreateCommand": "java -version",
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	// Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
 | 
						// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
 | 
				
			||||||
	"remoteUser": "vscode"
 | 
						// "remoteUser": "root"
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										23
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										23
									
								
								README.md
									
									
									
									
									
								
							@@ -2,7 +2,7 @@
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode-remote-try-java)
 | 
					[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode-remote-try-java)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
A **development container** is a running [Docker](https://www.docker.com) container with a well-defined tool/runtime stack and its prerequisites. You can try out development containers with **[GitHub Codespaces](https://github.com/features/codespaces)** or **[Visual Studio Code Dev Containers](https://aka.ms/vscode-remote/containers)**.
 | 
					A **development container** is a running container with a well-defined tool/runtime stack and its prerequisites. You can try out development containers with **[GitHub Codespaces](https://github.com/features/codespaces)** or **[Visual Studio Code Dev Containers](https://aka.ms/vscode-remote/containers)**.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This is a sample project that lets you try out either option in a few easy steps. We have a variety of other [vscode-remote-try-*](https://github.com/search?q=org%3Amicrosoft+vscode-remote-try-&type=Repositories) sample projects, too.
 | 
					This is a sample project that lets you try out either option in a few easy steps. We have a variety of other [vscode-remote-try-*](https://github.com/search?q=org%3Amicrosoft+vscode-remote-try-&type=Repositories) sample projects, too.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -12,8 +12,9 @@ This is a sample project that lets you try out either option in a few easy steps
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
### GitHub Codespaces
 | 
					### GitHub Codespaces
 | 
				
			||||||
Follow these steps to open this sample in a Codespace:
 | 
					Follow these steps to open this sample in a Codespace:
 | 
				
			||||||
1. Click the Code drop-down menu and select the **Open with Codespaces** option.
 | 
					1. Click the **Code** drop-down menu.
 | 
				
			||||||
1. Select **+ New codespace** at the bottom on the pane.
 | 
					2. Click on the **Codespaces** tab.
 | 
				
			||||||
 | 
					3. Click **Create codespace on main**.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
For more info, check out the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace).
 | 
					For more info, check out the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -41,25 +42,35 @@ Follow these steps to open this sample in a container using the VS Code Dev Cont
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
Once you have this sample opened, you'll be able to work with it like you would locally.
 | 
					Once you have this sample opened, you'll be able to work with it like you would locally.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
> **Note:** This container runs as a non-root user with sudo access by default. Comment out `"remoteUser": "vscode"` in `.devcontainer/devcontainer.json` if you'd prefer to run as root.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Some things to try:
 | 
					Some things to try:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1. **Edit:**
 | 
					1. **Edit:**
 | 
				
			||||||
   - Open `src/main/java/com/mycompany/app/App.java`.
 | 
					   - Open `src/main/java/com/mycompany/app/App.java`.
 | 
				
			||||||
   - Try adding some code and check out the language features.
 | 
					   - Try adding some code and check out the language features.
 | 
				
			||||||
   - Notice that the Java extension pack is already installed in the container since the `.devcontainer/devcontainer.json` lists `"vscjava.vscode-java-pack"` as an extension to install automatically when the container is created.
 | 
					   - Make a spelling mistake and notice it is detected. The [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) extension was automatically installed because it is referenced in `.devcontainer/devcontainer.json`.
 | 
				
			||||||
 | 
					   - Also notice that the [Extension Pack for Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) is installed. The JDK is in the `mcr.microsoft.com/devcontainers/java` image and Dev Container settings and metadata are automatically picked up from [image labels](https://containers.dev/implementors/reference/#labels).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
2. **Terminal:** Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>\`</kbd> and type `uname` and other Linux commands from the terminal window.
 | 
					2. **Terminal:** Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>\`</kbd> and type `uname` and other Linux commands from the terminal window.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
3. **Build, Run, and Debug:**
 | 
					3. **Build, Run, and Debug:**
 | 
				
			||||||
   - Open `src/main/java/com/mycompany/app/App.java`.
 | 
					   - Open `src/main/java/com/mycompany/app/App.java`.
 | 
				
			||||||
   - Add a breakpoint.
 | 
					   - Add a breakpoint.
 | 
				
			||||||
   - Press <kbd>F5</kbd> to launch the app in the container.
 | 
					   - Press <kbd>F5</kbd> to launch the app in the container.
 | 
				
			||||||
   - Once the breakpoint is hit, try hovering over variables, examining locals, and more.
 | 
					   - Once the breakpoint is hit, try hovering over variables, examining locals, and more.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
4. **Run a Test:**
 | 
					4. **Run a Test:**
 | 
				
			||||||
   - Open `src/test/java/com/mycompany/app/AppTest.java`.
 | 
					   - Open `src/test/java/com/mycompany/app/AppTest.java`.
 | 
				
			||||||
   - Put a breakpoint in a test.
 | 
					   - Put a breakpoint in a test.
 | 
				
			||||||
   - Click the `Debug Test` in the Code Lens above the function and watch it hit the breakpoint.
 | 
					   - Click the `Debug Test` in the Code Lens above the function and watch it hit the breakpoint.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					5. **Install Node.js using a Dev Container Feature:**
 | 
				
			||||||
 | 
					   - Press <kbd>F1</kbd> and select the **Dev Containers: Configure Container Features...** or **Codespaces: Configure Container Features...** command.
 | 
				
			||||||
 | 
					   - Type "node" in the text box at the top.
 | 
				
			||||||
 | 
					   - Check the check box next to "Node.js (via nvm) and yarn" (published by devcontainers) 
 | 
				
			||||||
 | 
					   - Click OK
 | 
				
			||||||
 | 
					   - Press <kbd>F1</kbd> and select the **Dev Containers: Rebuild Container** or **Codespaces: Rebuild Container** command so the modifications are picked up.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					  
 | 
				
			||||||
## Contributing
 | 
					## Contributing
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
 | 
					This project welcomes contributions and suggestions. Most contributions require you to agree to a
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user