This action runs an instance of VS Code and runs in in the default web browser.
It requires the name of the image on which to run VS Code and references to the following 5 volumes: data, code, config, notebooks, and results. These volumes will be mounted to /project/data, /project/modules, /project/config, /project/notebooks and /project/results respectively.
jobs:
vscode:
action: gh:neuro-actions/vscode@@v1.0.1
args:
volumes_data_remote: $[[ volumes.data.remote ]]
volumes_code_remote: $[[ volumes.code.remote ]]
volumes_config_remote: $[[ volumes.config.remote ]]
volumes_notebooks_remote: $[[ volumes.notebooks.remote ]]
volumes_results_remote: $[[ volumes.results.remote ]]
The name of the image on which to run the VS Code instance.
Default is neuromation/base
. If you use an image that's not derived from neuromation/base
, make sure it has the VS Code server installed.
args:
image: neuromation/base
Predictable subdomain name that will replace the job's ID in the full job URI. ""
by default
args:
job_name: "vscode-job"
HTTP port to use for VS Code. "8080"
by default.
args:
http_port: 8282
Whether to use HTTP authentication for VS Code Web UI or not. "True"
by default.
args:
http_auth: "false"
Reference to a data volume.
args:
volumes_data_remote: $[[ volumes.data.remote ]]
Reference to a code volume.
args:
volumes_code_remote: $[[ volumes.code.remote ]]
Reference to a config volume.
args:
volumes_config_remote: $[[ volumes.config.remote ]]
Reference to a notebooks volume.
args:
volumes_notebooks_remote: $[[ volumes.notebooks.remote ]]
Reference to a results volume.
args:
volumes_results_remote: $[[ volumes.results.remote ]]