templates/go
Template
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Switch to dynamic port forwarding, update readme

Browse Source
This commit is contained in:
Brigit Murtaugh
2021-01-21 16:49:31 +00:00
committed by GitHub
parent 7f5ea9fa59
commit b927b54605
2 changed files with 31 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@@ -1,20 +1,30 @@
# Try Out Development Containers: Go
This is a sample project that lets you try out the **[VS Code Remote - Containers](https://aka.ms/vscode-remote/containers)** extension in a few easy steps.
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 Remote - Containers](https://aka.ms/vscode-remote/containers)**.
> **Note:** If you're following the quick start, you can jump to the [Things to try](#things-to-try) section.
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.
> **Note:** If you already have a Codespace or dev container, you can jump to the [Things to try](#things-to-try) section.
## Setting up the development container
Follow these steps to open this sample in a container:
### GitHub Codespaces
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. Select **+ New codespace** at the bottom on the pane. If you don't own the repo, this will create a fork of this repository under your account.
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started).
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).
### VS Code Remote - Containers
Follow these steps to open this sample in a container using the VS Code Remote - Containers extension:
1. If this is your first time using a development container, please ensure your system meets the pre-reqs (i.e. have Docker installed) in the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started).
2. To use this repository, you can either open the repository in an isolated Docker volume:
- Press <kbd>F1</kbd> and select the **Remote-Containers: Try a Sample...** command.
- Choose the "Go" sample, wait for the container to start and try things out!
> **Note:** Under the hood, this will use **Remote-Containers: Open Repository in Container...** command to clone the source code in a Docker volume instead of the local filesystem.
- Choose the "Go" sample, wait for the container to start, and try things out!
> **Note:** Under the hood, this will use the **Remote-Containers: Clone Repository in Container Volume...** command to clone the source code in a Docker volume instead of the local filesystem. [Volumes](https://docs.docker.com/storage/volumes/) are the preferred mechanism for persisting container data.
Or open a locally cloned copy of the code:
@@ -24,7 +34,7 @@ Follow these steps to open this sample in a container:
## Things to try
Once you have this sample opened in a container, 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.
@@ -33,6 +43,7 @@ Some things to try:
1. **Edit:**
- Open `server.go`
- Try adding some code and check out the language features.
- Notice the Go extension is already installed in the container since the `.devcontainer/devcontainer.json` lists `"golang.Go"` as an extension to install automatically when the container is created.
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:**
- Open `server.go`
@@ -40,14 +51,18 @@ Some things to try:
- Press <kbd>F5</kbd> to launch the app in the container.
- Once the breakpoint is hit, try hovering over variables, examining locals, and more.
- Continue, then open a local browser and go to `http://localhost:9000` and note you can connect to the server in the container.
4. **Forward another port:**
- Stop debugging and remove the breakpoint.
- Open `server.go`
- Change the server port to 5000. (`portNumber := "5000"`)
- Press <kbd>F5</kbd> to launch the app in the container.
- Press <kbd>F1</kbd> and run the **Forward a Port** command.
- Select port 5000.
- Click "Open Browser" in the notification that appears to access the web app on this new port.
- The status line shows '1 Port Available'. Clicking the status bar entry shows the 'Ports' view that lists the currently available ports.
4. **Rebuild or update your container:** (*Currently, only containers with the VS Code Remote - Containers extension can be rebuilt.*)
You may want to make changes to your container, such as installing a different version of a software or forwarding a new port. You'll rebuild your container for your changes to take effect.
**Forward a port statically:** As an example change, let's forward a port statically in the `.devcontainer/devcontainer.json` file.
> **Note:** Remote-Containers and Codespaces also take care of dynamic port forwarding, but there may be instances in which we want to statically declare a forwarded port.
- Open the `.devcontainer/devcontainer.json` file.
- Uncomment the `forwardedPorts` attribute and adjust the port number as needed.
- Press <kbd>F1</kbd> and select the **Remote-Containers: Rebuild Container** command so the modifications are picked up.
5. **Refactoring - rename:**
- Open `hello.go`, select method name `Hello` press <kbd>F1</kbd> and run the **Rename Symbol** command.
6. **Refactoring - extract:**
@@ -66,8 +81,6 @@ Some things to try:
10. **Add json tags to structs:** ([details](https://github.com/fatih/gomodifytags))
- Open `hello.go` and go with cursor in to a struct, press <kbd>F1</kbd> and run the **Go: Add Tags To Struct Fields** command.
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a