我将AWS CodeBuild设置为从GitHub自动构建。其他CI服务为分支提供环境变量,但我找不到AWS CodeBuild的环境变量。有一个CODEBUILD_SOURCE_VERSION
被设置为pr/7
,其中7
是拉请求号或git commit sha。
鉴于提交sha,我一直试图获得分支名称,但到目前为止没有运气。
git branch --contains <commitsha>
不起作用,因为它是一个独立的头。如何从CodeBuild获取提交的git分支?
你可以运行:
git branch -a --contains <sha>
-a
指所有分支。如果你的sha没有分支,在某些情况下可能会发生,你将看不到任何东西。
你可以从https://github.com/thii/aws-codebuild-extras获得灵感
⚠️I不建议为curl
运行security sake命令!如果一些vilain偷走了thii/aws-codebuild-extras回购,你就搞砸了!
只需copy paste the script(了解它!)并将其添加到您的docker镜像,然后从您的文件系统中调用它。
#!/bin/bash
export CI=true
export CODEBUILD=true
export CODEBUILD_GIT_BRANCH=`git symbolic-ref HEAD --short 2>/dev/null`
if [ "$CODEBUILD_GIT_BRANCH" == "" ] ; then
CODEBUILD_GIT_BRANCH=`git branch -a --contains HEAD | sed -n 2p | awk '{ printf $1 }'`
export CODEBUILD_GIT_BRANCH=${CODEBUILD_GIT_BRANCH#remotes/origin/}
fi
export CODEBUILD_GIT_MESSAGE=`git log -1 --pretty=%B`
export CODEBUILD_GIT_AUTHOR=`git log -1 --pretty=%an`
export CODEBUILD_GIT_AUTHOR_EMAIL=`git log -1 --pretty=%ae`
export CODEBUILD_GIT_COMMIT=`git log -1 --pretty=%H`
export CODEBUILD_GIT_TAG=`git describe --tags --abbrev=0`
export CODEBUILD_PULL_REQUEST=false
if [[ $CODEBUILD_GIT_BRANCH == pr-* ]] ; then
export CODEBUILD_PULL_REQUEST=${CODEBUILD_GIT_BRANCH#pr-}
fi
export CODEBUILD_PROJECT=${CODEBUILD_BUILD_ID%:$CODEBUILD_LOG_PATH}
export CODEBUILD_BUILD_URL=https://$AWS_DEFAULT_REGION.console.aws.amazon.com/codebuild/home?region=$AWS_DEFAULT_REGION#/builds/$CODEBUILD_BUILD_ID/view/new
echo "==> AWS CodeBuild Extra Environment Variables:"
echo "==> CI = $CI"
echo "==> CODEBUILD = $CODEBUILD"
echo "==> CODEBUILD_GIT_AUTHOR = $CODEBUILD_GIT_AUTHOR"
echo "==> CODEBUILD_GIT_AUTHOR_EMAIL = $CODEBUILD_GIT_AUTHOR_EMAIL"
echo "==> CODEBUILD_GIT_BRANCH = $CODEBUILD_GIT_BRANCH "
echo "==> CODEBUILD_GIT_COMMIT = $CODEBUILD_GIT_COMMIT"
echo "==> CODEBUILD_GIT_MESSAGE = $CODEBUILD_GIT_MESSAGE"
echo "==> CODEBUILD_GIT_TAG = $CODEBUILD_GIT_TAG"
echo "==> CODEBUILD_PROJECT = $CODEBUILD_PROJECT"
echo "==> CODEBUILD_PULL_REQUEST = $CODEBUILD_PULL_REQUEST"
将以下命令添加到buildspec.yml的install
或pre_build
阶段:
bash -c "$(curl -fsSL https://raw.githubusercontent.com/thii/aws-codebuild-extras/master/install)"
您可以通过以下环境变量获得有关构建的更多信息:CI
,CODEBUILD
,CODEBUILD_GIT_AUTHOR
,CODEBUILD_GIT_AUTHOR_EMAIL
,CODEBUILD_GIT_BRANCH
,CODEBUILD_GIT_COMMIT
,CODEBUILD_GIT_MESSAGE
,CODEBUILD_GIT_TAG
,CODEBUILD_PROJECT
,CODEBUILD_PULL_REQUEST
。
现在可以直接从CodeBuild environmental variables获取此信息:
CODEBUILD_WEBHOOK_BASE_REF
:触发当前构建的webhook事件的基本引用名称。对于pull请求,这是分支引用。CODEBUILD_WEBHOOK_HEAD_REF
:触发当前构建的webhook事件的头引用名称。它可以是分支引用或标记引用。CODEBUILD_WEBHOOK_TRIGGER
:显示触发构建的webhook事件。此变量仅适用于由webhook触发的构建。该值是从Github,Github Enterprise或Bitbucket发送到CodeBuild的有效负载中解析的。值的格式取决于触发构建的事件类型。 对于由pull请求触发的构建,它是pr / pull-request-number。 对于通过创建新分支或将提交推送到分支而触发的构建,它是分支/分支名称。 对于通过将标记推送到存储库而触发的构建,它是标记/标记名称。
CodeBuild从文件系统中剥离git信息。没有.git
文件夹,因此运行git命令将毫无结果。
我在CI / CD CloudFormation模板中添加了一个参数:
GitBranch:
Description: Github branch to be deployed
Type: String
Default: master
我有一个创建/更新CI / CD堆栈的Bash脚本:
readonly git_branch=$(git branch 2>/dev/null | grep "^*" | colrm 1 2)
aws cloudformation create-stack \
--stack-name ${cicd_stack_name} \
--parameters ParameterKey=GitBranch,ParameterValue=${git_branch}
然后我将值作为环境变量导出到CodeBuild机器:
CodeBuildProject:
Type: AWS::CodeBuild::Project
Properties:
Environment:
Type: LINUX_CONTAINER
Image: aws/codebuild/java:openjdk-8
EnvironmentVariables:
- Name: GIT_BRANCH
Value: !Ref GitBranch
现在我可以在buildspec.yml中访问它:
post_build:
commands:
- echo [PHASE] Entered the post_build phase...
- echo "[DEBUG] Git branch ${GIT_BRANCH}"