如何在GitHub Codespaces的devcontainer.json中配置dotnet用户密钥及文件生成

问题 #

我需要创建一个devcontainer.json文件，实现以下功能：

1. 安装.NET SDK、Node.js、Git和Git LFS
2. 安装VS Code自定义扩展
3. 容器创建时执行命令，为.NET项目添加dotnet用户密钥，为React项目创建.env.development文件

前两项已成功实现，但第三项用postCreateCommand和postStartCommand都不生效：打开Codespaces后，.NET项目的用户密钥为空，.env.development文件也未生成。手动执行命令可正常运行，怀疑是路径问题或竞态条件（如dotnet CLI未就绪），但GitHub日志有限。想确认是否可以通过dotnet CLI添加用户密钥并创建文本文件，当前配置如下：

{
  // Name for the dev container displayed in the UI
  "name": "MyBlog Default Dev Container",
  // Base image meant to serve as a starting point for creating development container images for various programming languages and tools
  "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
  // Features to add to the dev container. More info: https://containers.dev/features.
  "features": {
    "ghcr.io/devcontainers/features/dotnet:1": {
      "version": "latest"
    },
    "ghcr.io/devcontainers/features/node:1": {
      "version": "latest"
    },
    "ghcr.io/devcontainers/features/git:1": {
      "version": "latest",
      "ppa": "false"
    },
    "ghcr.io/devcontainers/features/git-lfs:1": {
      "version": "latest"
    }
  },
  // Configure tool-specific properties.
  "customizations": {
    // Configure properties specific to VS Code.
    "vscode": {
      // Add the IDs of extensions you want installed when the container is created.
      "extensions": [
        "ms-dotnettools.csharp",
        "yzhang.markdown-all-in-one",
        "sibiraj-s.vscode-scss-formatter",
        "dbaeumer.vscode-eslint",
        "dsznajder.es7-react-js-snippets",
        "adrianwilczynski.user-secrets"
      ]
    }
  },
  // Use 'postStartCommand' to run commands after the container is started.
  "postStartCommand": [
    "export ASPNETCORE_ENVIRONMENT=Development",
    "dotnet user-secrets set ConnectionStrings:MYBLOG_SQLITE ${CONNSTR_MYBLOG_SQLITE_LOCAL} --project ./src/MyBlog.WebApi/MyBlog.WebApi.csproj",
    "dotnet user-secrets set AzureAd:Instance https://login.microsoftonline.com/ --project ./src/MyBlog.WebApi/MyBlog.WebApi.csproj",
    "dotnet user-secrets set AzureAd:ClientId ${AZURE_AD_CLIENT_ID} --project ./src/MyBlog.WebApi/MyBlog.WebApi.csproj",
    "dotnet user-secrets set AzureAd:TenantId ${AZURE_AD_TENANT_ID} --project ./src/MyBlog.WebApi/MyBlog.WebApi.csproj",
    "echo REACT_APP_SERVER_URL=http://localhost:5000 > ./src/react-myblog/.env.development",
    "echo REACT_APP_REDIRECT_URL=http://localhost:3000 >> ./src/react-myblog/.env.development",
    "echo REACT_APP_CLIENT_ID=${AZURE_AD_CLIENT_ID} >> ./src/react-myblog/.env.development",
    "echo REACT_APP_TENANT_ID=${AZURE_AD_TENANT_ID} >> ./src/react-myblog/.env.development"
  ]
  // This ensures that the commands you run within the container execute with the correct permissions, and the file ownership and permissions align with the "codespace" user
  //"remoteUser": "codespace",
  //"containerUser": "codespace",
  // Specify a list of ports that should be forwarded from the Dev Container to the local machine
  //"forwardPorts": [3000, 5000,5001]
}

解决方案 #

1. 修复命令执行逻辑 #

你当前将postStartCommand写成数组形式，每个命令会在独立的shell进程中执行，导致环境变量无法传递、上下文不一致。需改为单字符串形式，用&&串联命令，确保命令在同一shell环境中执行。

2. 确保路径绝对正确 #

使用容器内置变量${containerWorkspaceFolder}指代工作区根目录，替换相对路径，避免容器启动时工作目录不一致的问题。

3. 修正执行时机 #

改用postCreateCommand而非postStartCommand——前者在容器创建完成、代码同步后执行，更适合初始化操作，能避免代码未同步导致的路径不存在问题。

4. 补全权限与目录检查 #

取消注释remoteUser和containerUser为codespace，确保命令以正确用户执行；添加mkdir -p确保React项目目录存在，避免文件写入失败。

修改后的完整配置 #

{
  "name": "MyBlog Default Dev Container",
  "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
  "features": {
    "ghcr.io/devcontainers/features/dotnet:1": {
      "version": "latest"
    },
    "ghcr.io/devcontainers/features/node:1": {
      "version": "latest"
    },
    "ghcr.io/devcontainers/features/git:1": {
      "version": "latest",
      "ppa": "false"
    },
    "ghcr.io/devcontainers/features/git-lfs:1": {
      "version": "latest"
    }
  },
  "customizations": {
    "vscode": {
      "extensions": [
        "ms-dotnettools.csharp",
        "yzhang.markdown-all-in-one",
        "sibiraj-s.vscode-scss-formatter",
        "dbaeumer.vscode-eslint",
        "dsznajder.es7-react-js-snippets",
        "adrianwilczynski.user-secrets"
      ]
    }
  },
  "remoteUser": "codespace",
  "containerUser": "codespace",
  "postCreateCommand": "export ASPNETCORE_ENVIRONMENT=Development && \
    dotnet user-secrets set ConnectionStrings:MYBLOG_SQLITE ${CONNSTR_MYBLOG_SQLITE_LOCAL} --project ${containerWorkspaceFolder}/src/MyBlog.WebApi/MyBlog.WebApi.csproj && \
    dotnet user-secrets set AzureAd:Instance https://login.microsoftonline.com/ --project ${containerWorkspaceFolder}/src/MyBlog.WebApi/MyBlog.WebApi.csproj && \
    dotnet user-secrets set AzureAd:ClientId ${AZURE_AD_CLIENT_ID} --project ${containerWorkspaceFolder}/src/MyBlog.WebApi/MyBlog.WebApi.csproj && \
    dotnet user-secrets set AzureAd:TenantId ${AZURE_AD_TENANT_ID} --project ${containerWorkspaceFolder}/src/MyBlog.WebApi/MyBlog.WebApi.csproj && \
    mkdir -p ${containerWorkspaceFolder}/src/react-myblog && \
    echo REACT_APP_SERVER_URL=http://localhost:5000 > ${containerWorkspaceFolder}/src/react-myblog/.env.development && \
    echo REACT_APP_REDIRECT_URL=http://localhost:3000 >> ${containerWorkspaceFolder}/src/react-myblog/.env.development && \
    echo REACT_APP_CLIENT_ID=${AZURE_AD_CLIENT_ID} >> ${containerWorkspaceFolder}/src/react-myblog/.env.development && \
    echo REACT_APP_TENANT_ID=${AZURE_AD_TENANT_ID} >> ${containerWorkspaceFolder}/src/react-myblog/.env.development"
}

额外注意事项 #

• 确保CONNSTR_MYBLOG_SQLITE_LOCAL、AZURE_AD_CLIENT_ID等环境变量已在Codespaces的Secrets中配置，或通过devcontainer的remoteEnv字段定义
• 若仍存在竞态条件，可在dotnet命令前添加sleep 5延迟，确保dotnet CLI完全就绪

内容的提问来源于stack exchange，提问作者Jossean Yamil