GitHub Commit Message Checker 安装与配置指南

GitHub Commit Message Checker 安装与配置指南

commit-message-checker GitHub Action that checks commit messages of pushes and pull request against a regex pattern 项目地址: https://gitcode.com/gh_mirrors/co/commit-message-checker

1. 项目基础介绍

GitHub Commit Message Checker 是一个开源的 GitHub Action 项目，用于检查提交到仓库的 Commit 消息是否符合特定的正则表达式模式。这个项目可以帮助维护代码库的一致性和规范性，确保所有提交都遵循预定义的格式。项目主要使用 TypeScript 编程语言开发。

2. 项目使用的关键技术和框架

• TypeScript: 用于编写 Action 的主要编程语言，提供了类型系统和编译时检查，增加了代码的可维护性和安全性。
• Node.js: 运行时环境，所有的 GitHub Actions 都在 Node.js 环境中执行。
• ESLint: 用于静态代码检查，确保代码质量和风格的一致性。
• Prettier: 用于代码格式化，统一代码风格。
• Jest: 用于单元测试，确保代码的可靠性。

3. 项目安装和配置的准备工作及详细步骤

准备工作

在开始之前，请确保你已经安装了以下工具：

• Git: 用于克隆和操作项目仓库。
• Node.js: 提供运行时环境，推荐使用 LTS 版本。
• npm 或 yarn: 用于管理项目依赖。

安装步骤

1. 克隆项目仓库

   打开终端（或命令提示符），执行以下命令来克隆项目：

   git clone https://github.com/GsActions/commit-message-checker.git
   

2. 安装依赖

   进入项目目录，安装项目依赖：

   cd commit-message-checker
   npm install
   

   或者如果你更喜欢使用 yarn：

   yarn install
   

3. 构建项目

   使用以下命令构建项目：

   npm run build
   

   这一步会编译 TypeScript 代码到 JavaScript。

4. 运行测试

   确保一切正常，可以运行测试套件：

   npm run test
   

5. 配置 GitHub Action

   在你的 GitHub 仓库中，创建一个新的 .github/workflows 目录（如果尚不存在），然后在该目录下创建一个 YAML 文件，例如 commit-message-checker.yml。以下是一个配置示例：

   name: Commit Message Check
   
   on:
     pull_request:
       types: [opened, edited, reopened, synchronize]
     push:
       branches: [main]
   
   jobs:
     check-commit-message:
       name: Check Commit Message
       runs-on: ubuntu-latest
       steps:
         - name: Check Commit Message
           uses: gsactions/commit-message-checker@v2
           with:
             pattern: '\[[^]]+\] .+$'
             flags: 'gm'
             error: '您的第一行必须包含一个提交类型，例如 "[BUGFIX]"。'
   

   根据您的需求，您可能需要调整上面的配置。

6. 提交和推送配置

   将您的配置文件添加到您的仓库中，并推送更改：

   git add .github/workflows/commit-message-checker.yml
   git commit -m "Add commit message checker workflow"
   git push origin main
   

   请替换 main 为您的默认分支名。

完成以上步骤后，您的项目就已经成功安装并配置好了 GitHub Commit Message Checker。现在，每次提交都应该符合您定义的 Commit 消息格式。

commit-message-checker GitHub Action that checks commit messages of pushes and pull request against a regex pattern 项目地址: https://gitcode.com/gh_mirrors/co/commit-message-checker