branch-names

分支名称

<!-- 所有贡献者徽章开始 - 请勿删除或修改此部分 -->

<!-- 所有贡献者徽章结束 -->

获取不带/ref/*前缀的分支或标签名称。

目录

• 特性
• 使用方法
• 输入
• 输出
• 事件
  • push*
  • pull_request*
  • tag*
  • 其他支持的事件
  • 与actions/checkout的可能用法
• 致谢
• 报告错误
• 贡献者 ✨

特性

• 获取不带任何前缀的当前分支名称。（例如：'refs/heads/main' -> 'main'）
• 获取当前标签，可选择去除前缀（例如：v0.0.1 -> v -> 0.0.1）
• 检测由非默认分支触发的操作
• 检测由默认分支触发的操作
• 支持所有有效的git分支名称

使用方法

...

    steps:
      - name: 获取分支名称
        id: branch-names
        uses: tj-actions/branch-names@v8
        
      - name: 在默认分支上运行
        if: steps.branch-names.outputs.is_default == 'true'
        run: |
          echo "在默认分支上运行: ${{ steps.branch-names.outputs.current_branch }}" 
        # 输出: "在默认分支上运行: main"
      
      - name: 在拉取请求分支上运行
        if: steps.branch-names.outputs.is_default == 'false'
        run: |
          echo "在PR上运行: ${{ steps.branch-names.outputs.current_branch }}"
        # 输出: "在PR上运行: feature/test"
      
      - name: 在拉取请求分支上运行
        if: steps.branch-names.outputs.is_default == 'false'
        run: |
          echo "基础分支: ${{ steps.branch-names.outputs.base_ref_branch }}"
        # 输出: "基础分支: main"
        
      - name: 在任何事件上运行
        run: |
          echo "默认分支: ${{ steps.branch-names.outputs.default_branch }}"
        # 输出: "默认分支: main"

如果您愿意慷慨一些并想表示额外的感谢：

请为这个项目点个 :star:

输入

<!-- 自动文档输入开始 - 请勿删除或修改此部分 -->

- uses: tj-actions/branch-names@v8
  id: branch-names
  with:
    # 应该从标签中去除的前缀
    # 例如 `v` -> 对于标签
    # `v0.0.1` -> 返回 `0.0.1` 
    # 类型: 字符串
    strip_tag_prefix: ''

<!-- 自动文档输入结束 -->

输出

<!-- 自动文档输出开始 - 请勿删除或修改此部分 -->

输出	类型	描述
<a name="output_base_ref_branch"></a>base_ref_branch	字符串	拉取请求或标签的目标分支,<br>例如 main
<a name="output_current_branch"></a>current_branch	字符串	无论事件类型如何的当前分支名称,<br>例如 main, feature/test
<a name="output_default_branch"></a>default_branch	字符串	默认分支名称,例如 <br>main 或 master
<a name="output_head_ref_branch"></a>head_ref_branch	字符串	拉取请求的源分支,<br>例如 feature/test
<a name="output_is_default"></a>is_default	字符串	如果当前分支是默认分支则返回<br>"true",否则返回 "false".
<a name="output_is_tag"></a>is_tag	字符串	如果当前分支是标签则返回<br>"true",否则返回 "false".
<a name="output_ref_branch"></a>ref_branch	字符串	触发工作流运行的分支.<br>例如 1/merge, main
<a name="output_tag"></a>tag	字符串	触发工作流运行的标签.<br>例如 v0.0.1, 0.0.1

<!-- AUTO-DOC-OUTPUT:END -->

事件

push*

on:
  push:
    branches:
      - main

...
    steps:
      - name: 获取分支名称
        id: branch-names
        uses: tj-actions/branch-names@v8

      - name: 当前分支名称
        run: |
          echo "${{ steps.branch-names.outputs.current_branch }}"
        # 输出: "main" 触发推送事件的分支。

      - name: 在默认分支上运行。
        if: steps.branch-names.outputs.is_default == 'true'
        run: |
          echo "在默认分支上运行: ${{ steps.branch-names.outputs.current_branch }}"
        # 输出: "在默认分支上运行: main"。
      
      - name: 在默认分支上运行（即非基于标签的分支）。
        if: steps.branch-names.outputs.is_tag == 'false' && steps.branch-names.outputs.is_default == 'true'
        run: |
          echo "在分支上运行: ${{ steps.branch-names.outputs.current_branch }}"
        # 输出: "在分支上运行: main"。
      
      - name: 获取Ref分支名称
        run: |
          echo "${{ steps.branch-names.outputs.ref_branch }}"
        #  输出: "main"
      
      - name: 默认分支名称
        run: |
          echo "${{ steps.branch-names.outputs.default_branch }}"
        # 输出: "main" 默认分支。

pull_request*

on:
  pull_request:
    branches:
      - main

...
    steps:
      - name: 获取分支名称
        id: branch-names
        uses: tj-actions/branch-names@v8
      
      - name: 当前分支名称
        run: |
          echo "${{ steps.branch-names.outputs.current_branch }}"
        # 输出: "feature/test" 当前PR分支。

      - name: 在非基于标签的分支和PR分支上运行。
        if: steps.branch-names.outputs.is_default == 'false'
        run: |
          echo "在分支上运行: ${{ steps.branch-names.outputs.current_branch }}"
        # 输出: "在分支上运行: feature/test"。
      
      - name: 在拉取请求上运行（即非基于标签的分支）。
        if: steps.branch-names.outputs.is_tag == 'false' && steps.branch-names.outputs.is_default == 'false'
        run: |
          echo "在分支上运行: ${{ steps.branch-names.outputs.current_branch }}"
        # 输出: "在分支上运行: feature/test"。
      
      - name: 获取Ref分支名称
        run: |
          echo "${{ steps.branch-names.outputs.ref_branch }}"
        #  输出: "1/merge"

      - name: 获取Head Ref分支名称（即当前拉取请求分支）
        run: |
          echo "${{ steps.branch-names.outputs.head_ref_branch }}"
        # 输出: "feature/test" 当前PR分支。

      - name: 获取Base Ref分支名称（即拉取请求的目标）
        run: |
          echo "${{ steps.branch-names.outputs.base_ref_branch }}"
        # 输出: "main"。
      
      - name: 默认分支名称
        run: |
          echo "${{ steps.branch-names.outputs.default_branch }}"
        # 输出: "main" 默认分支。

tag*

on:
  push:
    tags:
      - '*'

...
    steps:
      - name: 获取分支名称
        id: branch-names
        uses: tj-actions/branch-names@v8
        with:
          strip_tag_prefix: v # 可选择从标签中去除开头的 `v`。
     
      - name: 在标签分支上运行。
        if: steps.branch-names.outputs.is_tag == 'true'
        run: |
          echo "运行于: ${{ steps.branch-names.outputs.tag }}"
        # 输出: "运行于: 0.0.1"。
        
      - name: 获取当前标签
        if: steps.branch-names.outputs.is_tag == 'true'  # 替换: startsWith(github.ref, 'refs/tags/')
        run: |
          echo "${{ steps.branch-names.outputs.tag }}"
        # 输出: "0.0.1"

其他支持的事件

查看 .github/workflows/test.yml 获取更多示例。

与 actions/checkout 的可能用法

on:
  pull_request:
    branches:
      - develop
    
 jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: 获取分支名称。
        id: branch-names
        uses: tj-actions/branch-names@v8
      - uses: actions/checkout@v4
        with:
          ref: ${{ steps.branch-names.outputs.head_ref_branch }}

• 免费软件: MIT 许可证

致谢

本包是使用 Cookiecutter 创建的。

报告错误

在 https://github.com/tj-actions/branch-names/issues 报告错误。

如果您要报告一个错误,请包括:

• 您的操作系统名称和版本。
• 任何可能有助于排除故障的工作流程详细信息。
• 重现该错误的详细步骤。

贡献者 ✨

感谢这些出色的人(表情符号键):

<!-- ALL-CONTRIBUTORS-LIST:START - 不要删除或修改此部分 --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/loarca"><img src="https://avatars.githubusercontent.com/u/22898638?v=4?s=100" width="100px;" alt="Alejandro Loarca"/><br />_{<b>Alejandro Loarca</b>}</a><br /><a href="https://github.com/tj-actions/branch-names/commits?author=loarca" title="代码">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://ianwoodard.me"><img src="https://avatars.githubusercontent.com/u/17186604?v=4?s=100" width="100px;" alt="Ian Woodard"/><br />_{<b>Ian Woodard</b>}</a><br /><a href="https://github.com/tj-actions/branch-names/commits?author=IanWoodard" title="文档">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://home.boidol.dev/"><img src="https://avatars.githubusercontent.com/u/652404?v=4?s=100" width="100px;" alt="Raphael Boidol"/><br />_{<b>Raphael Boidol</b>}</a><br /><a href="https://github.com/tj-actions/branch-names/commits?author=boidolr" title="文档">📖</a></td> </tr> </tbody> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->

本项目遵循all-contributors规范。欢迎任何形式的贡献！