GitHub Action 自动化版本迭代工具：gh-action-bump-version 指南

GitHub Action 自动化版本迭代工具：gh-action-bump-version 指南

gh-action-bump-version项目地址:https://gitcode.com/gh_mirrors/gh/gh-action-bump-version

本指南将详细介绍如何利用 gh-action-bump-version 这个开源项目来自动化您的npm包版本管理。此项目由 phips28 开发，旨在简化版本号的自动更新过程，尤其适用于基于GitHub的工作流程。

1. 项目目录结构及介绍

尽管具体的项目结构在GitHub仓库中未直接详细列出，但根据典型的GitHub Action项目惯例，我们可以推测其基本组成：

• .github/workflows: 此目录存放所有GitHub Actions的配置文件（如 yml 文件），定义了工作流的具体执行逻辑。
• action.yml: GitHub Action的核心配置文件，描述了Action的基本元数据，如名称、输入参数、运行环境等。
• src （假设存在）: 若项目包含源代码，这里可能存放处理版本迭代的脚本或函数。
• README.md: 项目的主要文档，包含了安装、配置和使用该GitHub Action的指导信息。

2. 项目的启动文件介绍

对于GitHub Action而言，并没有一个传统的“启动文件”，而是通过.github/workflows中的YAML文件定义动作的触发条件和执行步骤。当你想要启用这个版本迭代功能时，会在自己的项目里创建或修改这样的YAML文件（通常是 .github/workflows/bump-version.yml 或自定义名字），示例如下：

name: Automated Version Bump
on:
  push:
    branches:
      - main # 或你的主分支名
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Automated Version Bump
      uses: phips28/gh-action-bump-version@master
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        minor-wording: 'add Adds new'
        major-wording: 'MAJOR cut-major'

这段配置指示当代码推送到指定分支时，自动执行版本号的升级流程。

3. 项目的配置文件介绍

主要的配置并不直接存在于项目内部供用户编辑的单个文件中，而是通过在调用该GitHub Action时的YAML文件里进行设置。以下是几个关键配置项的解释：

• minor-wording, major-wording, patch-wording: 定义触发小版本、大版本、补丁版本升级的关键词。
• version-type: 允许手动覆盖版本类型，不依赖于提交消息分析。
• push: 控制是否推送更改到远程仓库，默认为true，若设为false，则不会实际推送版本标签和更新后的package.json。
• target-branch: 可选，指明版本迭代后应提交至的目标分支。
• commit-message: 自定义版本迭代的提交信息。
• bump-policy: 版本迭代策略，可以设定为检查所有提交消息（默认）或忽略之前的版本迭代。

总结来说，通过上述方式，您可以无需手动操作，即可基于提交信息自动完成npm包的版本迭代，大大提升了开发效率并保证了版本控制的一致性和准确性。

gh-action-bump-version项目地址:https://gitcode.com/gh_mirrors/gh/gh-action-bump-version