目录

1. 基础知识概述
2. 获取 Commit 信息的方法
3. 实战应用场景
4. 高级用法与技巧
5. 最佳实践
6. 常见问题解答

一、基础知识概述

在 GitHub Actions 中，可以通过内置变量和上下文获取提交信息。以下是最常用的方法：

1. 默认环境变量

YAML

name:GetCommitInfoon:push:branches: [ main ]

jobs:info:runs-on:ubuntu-lateststeps:-name:ShowCommitInforun:|
          echo "Commit SHA: $GITHUB_SHA"
          echo "Ref: $GITHUB_REF"

2. GitHub Context 变量

YAML

jobs:commit-info:runs-on:ubuntu-lateststeps:-name:DisplayGitHubContextrun:|
          echo "Commit Message: ${{ github.event.head_commit.message }}"
          echo "Author: ${{ github.event.head_commit.author.name }}"

二、获取 Commit 信息的方法

1. 基本提交信息获取

YAML

steps:-name:GetBasicCommitInforun:|
      echo "Commit SHA: ${{ github.sha }}"
      echo "Short SHA: ${GITHUB_SHA::7}"
      echo "Branch: ${{ github.ref }}"

2. 详细提交信息

YAML

steps:-uses:actions/checkout@v4-name:GetDetailedCommitInforun:|
      echo "提交者: $(git log -1 --pretty=format:'%an')"
      echo "提交时间: $(git log -1 --pretty=format:'%ad')"
      echo "提交消息: $(git log -1 --pretty=format:'%s')"

3. 获取变更文件列表

YAML

steps:-uses:actions/checkout@v4with:fetch-depth:0-name:GetChangedFilesrun:|
      echo "Changed files:"
      git diff-tree --no-commit-id --name-only -r ${{ github.sha }}

三、实战应用场景

1. 根据提交消息触发不同任务

YAML

jobs:conditional:runs-on:ubuntu-lateststeps:-name:CheckCommitMessagerun:|
          if [[ "${{ github.event.head_commit.message }}" == *"[skip ci]"* ]]; then
            echo "CI skip requested"
            exit 0
          fi

2. 版本号提取

YAML

steps:-name:ExtractVersionif:startsWith(github.ref,'refs/tags/')run:|
      VERSION=${GITHUB_REF#refs/tags/}
      echo "VERSION=$VERSION" >> $GITHUB_ENV

3. 更新日志生成

YAML

steps:-uses:actions/checkout@v4with:fetch-depth:0-name:GenerateChangelogrun:|
      echo "## 更新内容" > changelog.md
      git log --pretty=format:"- %s" $(git describe --tags --abbrev=0)..HEAD >> changelog.md

四、高级用法与技巧

1. 多提交信息处理

YAML

steps:-name:ProcessMultipleCommitsrun:|
      git log -5 --pretty=format:"%h - %s" | while read line; do
        echo "处理提交: $line"
        # 处理每个提交
      done

2. 提交统计信息

YAML

steps:-name:CommitStatisticsrun:|
      echo "文件变更统计："
      git diff --stat ${{ github.event.before }} ${{ github.event.after }}

五、最佳实践

1. 错误处理

YAML

steps:-name:SafeCommitInfoFetchrun:|
      if ! git rev-parse --verify HEAD >/dev/null 2>&1; then
        echo "无法获取提交信息"
        exit 1
      fi
      # 继续处理

2. 信息缓存

YAML

steps:-name:CacheCommitInfoid:commit-cacherun:|
      echo "commit_hash=${GITHUB_SHA}" >> $GITHUB_OUTPUT
      echo "commit_date=$(git log -1 --format=%cd)" >> $GITHUB_OUTPUT

六、常见问题解答

Q1: 如何获取特定提交的作者邮箱？

YAML

steps:-name:GetAuthorEmailrun:|echo"作者邮箱: $(git log -1 --pretty=format:'%ae')"

Q2: 如何比较两次提交的差异？

YAML

steps:-name:CompareCommitsrun:|gitdiff${{github.event.before}}${{github.event.after}}--name-status

实用代码片段

1. 获取完整提交信息

YAML

jobs:full-info:runs-on:ubuntu-lateststeps:-uses:actions/checkout@v4-name:FullCommitInforun:|
          {
            echo "提交 SHA: ${GITHUB_SHA}"
            echo "分支: ${GITHUB_REF}"
            echo "提交者: $(git log -1 --pretty=format:'%an')"
            echo "邮箱: $(git log -1 --pretty=format:'%ae')"
            echo "时间: $(git log -1 --pretty=format:'%ad')"
            echo "消息: $(git log -1 --pretty=format:'%s')"
          } > commit_info.txt

2. 自动版本标记

YAML

jobs:version:runs-on:ubuntu-lateststeps:-name:TagVersionif:"contains(github.event.head_commit.message, 'release:')"run:|
          VERSION=$(echo "${{ github.event.head_commit.message }}" | grep -oP 'release: \K.*')
          git tag $VERSION
          git push origin $VERSION

关键词

• GitHub Actions commit 信息
• 工作流提交数据
• CI/CD 提交处理
• GitHub 自动化提交
• Actions 版本控制
• Git 提交信息获取
• 持续集成提交处理
• GitHub 工作流触发器

注意事项

1. 确保正确设置 actions/checkout 的 fetch-depth
2. 注意处理大型仓库的性能问题
3. 避免在日志中暴露敏感信息
4. 使用适当的错误处理机制
5. 考虑信息缓存以提高性能

[最后更新: 2025年1月]

#GitHub #GitHubActions #DevOps #CI #Automation #Git #Development