在 GitHub 操作中获取当前分支和提交哈希

Question

我想使用 GitHub 操作构建一个 docker 映像，从 TeamCity 迁移。

在构建脚本中，我想用分支和提交的组合标记图像，例如master.ad959de。在本地测试，我得到这样的信息：

git_branch=`git symbolic-ref --short HEAD`
git_hash=`git rev-parse --short HEAD`
docker_version=${git_branch}.${git_hash}

这是 GitHub 操作的相关部分：

name: CI
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1

    - name: Create docker image
      run: ./docker-build.sh  

在该 GitHub 操作中运行该脚本会导致此错误：

fatal: ref HEAD is not a symbolic ref

如何在 GitHub 操作中生成类似的标签？

Answer 1

来自Using environment variables

github 提供了两个在这里有用的变量，您需要对它们进行一些处理以获得您想要的值：

GITHUB_SHA：触发工作流的提交 SHA。例如，ffac537e6cbbf934b08745a378932722df287a53。

GITHUB_REF：触发工作流的分支或标签引用。例如，refs/heads/feature-branch-1。如果事件类型的分支或标签均不可用，则该变量将不存在。

短值可以这样提取：

git_hash=$(git rev-parse --short "$GITHUB_SHA")
git_branch=${GITHUB_REF#refs/heads/}

Answer 2

在工作流中获取当前分支并提交 sha 的一种便捷方法是获取它并保存在“变量”中。

  - name: Declare some variables
    id: vars
    shell: bash
    run: |
      echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
      echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"

  - name: Another step
    run: |
      echo "Branch: ${{ steps.vars.outputs.branch }}"
      echo "Sha: ${{ steps.vars.outputs.sha_short }}"

也许你的docker-build.sh 可以接收分支和她作为参数，完整版本作为参数。

  - name: Create docker image
     run: ./docker-build.sh "${{ steps.vars.outputs.branch }}.${{ steps.vars.outputs.sha_short }}"

或者只是

  - name: Create docker image
     run: ./docker-build.sh "${GITHUB_REF#refs/heads/}.${GITHUB_SHA}"

---

在this action 上，您可以看到我进行的许多测试，看看哪些有效，哪些无效。

Answer 3

另一种方法是使用github context。

- name: Create docker image
  run: ./docker-build.sh ${{ github.head_ref }}.${{ github.sha }}

这种方法的好处是您不必添加步骤来设置值。请注意，它使用的是完整版的 sha（不是短版）。

Answer 4

使用Environment variables 获得缩短的 SHA 的最简单方法：

- name: Build Docker Image
    run: ./docker-build.sh alpha.${GITHUB_SHA::6}

Answer 5

你可以通过这种方式在你的 sh 文件中获取它 -

BRANCH_NAME=$(echo $GITHUB_REF | cut -d'/' -f 3)
GITHUB_SHA_SHORT=$(echo $GITHUB_SHA | cut -c1-7)

Answer 6

也许是这样

name: CI 
on: push 
jobs:   
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1

    - name: Get Branch
      id: branch
      run: echo "git_branch=${GITHUB_REF#refs/heads/}" >> $GITHUB_BRANCH

    - name: Check Branch
      run: echo "${{ env.branch }}"

    - name: Get Hash
      id: hash
      run: echo "git_hash=$(git rev-parse --short "$GITHUB_SHA")" >> $GITHUB_HASH

    - name: Check Hash
      run: echo "${{ env.hash }}"

    - name: Create docker image
      run: ./docker-build.sh ${{ env.branch }} ${{ env.hash }}

Answer 7

使用https://github.com/tj-actions/branch-names 提供的输出也适用于push 和pull_request 事件

...
    steps:
      - uses: actions/checkout@v2
      - name: Get branch names
        uses: tj-actions/branch-names@v2.1
        id: branch-names
      
      - name: Current branch name
        if: github.event_name == 'pull_request'
        run: |
          echo "${{ steps.branch-name.outputs.current_branch }}"
        # Outputs: "feature/test" current PR branch.
      
      - name: Current branch name
        if: github.event_name == 'push'
        run: |
          echo "${{ steps.branch-name.outputs.current_branch }}"
        # Outputs: "main" the default branch that triggered the push event.
      
      - name: Get Ref brach name
        run: |
          echo "${{ steps.branch-name.outputs.ref_branch }}"
        #  Outputs: "main" for non PR branches | "1/merge" for a PR branch

      - name: Get Head Ref branch name
        if: github.event_name == 'pull_request'
        run: |
          echo "${{ steps.branch-name.outputs.head_ref_branch }}"
        # Outputs: "feature/test" current PR branch.

      - name: Get Base Ref branch name
        if: github.event_name == 'pull_request'
        run: |
          echo "${{ steps.branch-name.outputs.base_ref_branch }}"
        # Outputs: "main" for main <- PR branch.

Answer 8

您应该能够使用 ${{ github.event.pull_request.head.sha }} 访问最新 Git 提交的 SHA，假设这是由拉取请求触发的操作