tagpr 项目使用教程

tagpr 项目使用教程

tagpr automatically creates and updates a pull request for unreleased items, tag them when they are merged, and create releases. 项目地址: https://gitcode.com/gh_mirrors/ta/tagpr

1. 项目介绍

tagpr 是一个用于自动化版本发布流程的 GitHub Action。它能够自动创建和更新未发布项目的 Pull Request，并在合并时打上标签并创建 GitHub 发布。tagpr 简化了发布流程，使得发布过程变得更加直观和易于管理。

2. 项目快速启动

2.1 安装与配置

首先，你需要在 GitHub 仓库中添加 tagpr 作为 GitHub Action。以下是一个简单的配置示例：

name: tagpr

on:
  push:
    branches:
      - main

jobs:
  tagpr:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: Songmu/tagpr@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

2.2 配置文件

tagpr 的配置文件通常位于仓库的根目录下，使用 gitconfig 格式。以下是一个示例配置：

[tagpr]
releaseBranch = main
versionFile = version.txt
vPrefix = true
changelog = true
command = echo "Release command"
template = "Pull request template"
release = true
majorLabels = major
minorLabels = minor

3. 应用案例和最佳实践

3.1 自动化版本发布

tagpr 可以帮助团队自动化版本发布流程。通过配置 tagpr，团队可以在每次合并到主分支时自动创建或更新发布 Pull Request，并在合并时自动打上标签和创建 GitHub 发布。

3.2 版本号管理

tagpr 支持通过标签和版本文件来管理版本号。你可以通过在 Pull Request 上添加标签（如 major 或 minor）来影响下一个版本的版本号。

4. 典型生态项目

4.1 GitHub Actions

tagpr 是一个典型的 GitHub Actions 项目，它充分利用了 GitHub 的自动化功能，帮助开发者简化版本发布流程。

4.2 版本管理工具

tagpr 可以与其他版本管理工具（如 semver）结合使用，进一步增强版本管理的自动化和灵活性。

通过以上步骤，你可以快速上手并使用 tagpr 来简化你的版本发布流程。

tagpr automatically creates and updates a pull request for unreleased items, tag them when they are merged, and create releases. 项目地址: https://gitcode.com/gh_mirrors/ta/tagpr