如何在AWS CDK的CodeBuild项目中将GitHub代码克隆到子目录？

CodeBuild原生的Project和GitHubSourceProps确实没有直接配置克隆目录的选项，要实现将源码拉取到当前目录的子目录中，需要通过自定义构建流程手动完成克隆操作，具体步骤如下：

1. 在buildspec.yml中添加手动克隆逻辑 #

利用CodeBuild提供的环境变量，在构建的pre_build阶段执行克隆命令，将源码拉取到指定子目录：

version: 0.2
phases:
  pre_build:
    commands:
      # 创建目标子目录
      mkdir -p ./raido-src
      # 克隆仓库到子目录，使用CodeBuild环境变量获取仓库地址
      # 如果是私有仓库，需确保CodeBuild已配置GitHub令牌，可使用带凭证的地址：
      # git clone https://${GITHUB_TOKEN}@github.com/au-research/raido-v2.git ./raido-src
      git clone $CODEBUILD_SOURCE_REPO_URL ./raido-src
      # 切换到触发构建的指定提交版本
      cd ./raido-src && git checkout $CODEBUILD_RESOLVED_SOURCE_VERSION && cd ..
  build:
    commands:
      # 进入子目录执行构建操作
      cd ./raido-src
      # 替换为你的实际构建命令，比如npm install、mvn package等
      npm install && npm run build
# 按需配置artifacts等其他字段

2. 在CDK项目中关联自定义buildspec #

如果使用CDK定义CodeBuild项目，可直接在Project配置中嵌入上述buildspec内容：

const project = new Project(scope, "RaidoDbS3Import", {
    vpc: props.vpc,
    subnetSelection: { subnetType: SubnetType.PRIVATE_WITH_NAT },
    securityGroups: props.securityGroups,
    source: Source.gitHub({owner: "au-research", repo: "raido-v2"}),
    buildSpec: BuildSpec.fromObject({
      version: "0.2",
      phases: {
        pre_build: {
          commands: [
            "mkdir -p ./raido-src",
            "git clone $CODEBUILD_SOURCE_REPO_URL ./raido-src",
            "cd ./raido-src && git checkout $CODEBUILD_RESOLVED_SOURCE_VERSION && cd .."
          ]
        },
        build: {
          commands: [
            "cd ./raido-src && npm install && npm run build"
          ]
        }
      }
    })
    // 其他项目配置...
});

关键说明 #

• CodeBuild默认会自动拉取源码到当前工作目录，若想避免目录混乱，可在pre_build开头添加rm -rf ./*清空默认拉取的文件。
• 私有仓库需在CodeBuild项目的源设置中配置GitHub个人访问令牌（PAT），构建环境会自动注入GITHUB_TOKEN环境变量，用于克隆时的身份验证。

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