Define shorter image names in devcontainer.json

[kitingChris]

I have the following devcontainer.json

{
	"name": "nextjs-testproject",
	"dockerComposeFile": ["../compose.devcontainer.yaml"],
	"service": "next-app-dev",
	"shutdownAction": "none",
	"remoteUser": "node",
	"workspaceFolder": "/app", 
	"postStartCommand": "cd next-app/ && yarn install"
  }

and compose.devcontainer.yaml

include:
  - compose.db.yaml

services:
  next-app-dev:
    image: vsc-nextjs-testproject/next-app-dev:latest
    build:
      context: ./next-app
      dockerfile: ../Dockerfile
      target: builder
    env_file:
      - ./.env
    volumes:
      - ./:/app:cached
    restart: always
    ports:
      - 3000:3000
    depends_on:
      db:
        condition: service_healthy
        restart: true
        required: true
    command: sleep infinity

unfortunatelly the image name is still overriden by devcontainer cli with vsc-nextjs-testproject-ce7fac6b01aea927495ff344c431c1b01ab39d70290c5ad64ecdcca2a823dbcc-uid

My idea: add an "image" option for devcontainer.json to specify the image name.

{
	"name": "nextjs-testproject",
	"dockerComposeFile": ["../compose.devcontainer.yaml"],
	"service": "next-app-dev",
	"image": "vsc-nextjs-testproject/next-app-dev:latest",
	"shutdownAction": "none",
	"remoteUser": "node",
	"workspaceFolder": "/app", 
	"postStartCommand": "cd next-app/ && yarn install"
  }

Or at least make the image name shorter. Please!

[sebst]

You can achieve that with the --name runArg:

{
  "name": "nextjs-testproject",
  "dockerComposeFile": [
    "../compose.devcontainer.yaml"
  ],
  "service": "next-app-dev",
  "runArgs": [
    "--name",
    "vsc-nextjs-testproject/next-app-dev:latest"
  ],
  "shutdownAction": "none",
  "remoteUser": "node",
  "workspaceFolder": "/app",
  "postStartCommand": "cd next-app/ && yarn install"
}

[kitingChris]

Oh yea thats a good workaround... But still would endorse the idea to generally shorten the image names and/or provide a more convenient method to define the image name.

[kitingChris]

Oh VSCode tells me "Property runArgs is not allowed."

[sebst]

Might not work with docker compose

[kitingChris]

yea unfortunatelly...
It seems like devcontainercli overrides the image name even if I define it explicit either in my docker compose or via the runArgs.