Conventional Release Labels 项目使用教程

孙纯茉Norma

于 2024-09-25 08:22:10 发布

阅读量641

点赞数 11

本文链接：https://blog.csdn.net/gitblog_00640/article/details/142510255

版权

Conventional Release Labels 项目使用教程

conventional-release-labels Apply labels for automatically generated release notes, based on conventionalcommits.org 项目地址: https://gitcode.com/gh_mirrors/co/conventional-release-labels

1. 项目介绍

Conventional Release Labels 是一个 GitHub Action，用于根据 Conventional Commits 规范自动为 Pull Request 添加标签。这些标签可以与 GitHub 的自动生成发布说明功能结合使用，帮助团队更好地管理和分类代码变更。

该项目的主要功能包括：

自动根据提交类型（如 feat、fix、breaking 等）为 Pull Request 添加标签。
支持自定义标签映射和忽略某些提交类型。
与 GitHub 的自动发布说明功能无缝集成。

2. 项目快速启动

2.1 安装与配置

首先，在你的 GitHub 仓库中创建一个新的 GitHub Actions 工作流文件，例如 github/workflows/conventional-label.yaml。

# 警告：不要在 pull_request_target 事件中检出不受信任的代码
on:
  pull_request_target:
    types: [opened, edited]

name: conventional-release-labels

jobs:
  label:
    runs-on: ubuntu-latest
    steps:
      - uses: bcoe/conventional-release-labels@v1

2.2 配置发布说明

接下来，创建一个 github/release.yaml 文件，配置发布说明的分类和标签。

changelog:
  exclude:
    labels:
      - ignore-for-release
  authors:
    - octocat
  categories:
    - title: Breaking Changes 🛠
      labels:
        - breaking
    - title: Exciting New Features 🎉
      labels:
        - feature
    - title: Fixes 🔧
      labels:
        - fix
    - title: Other Changes
      labels:
        - "*"