GsActions Commit Message Checker 使用教程

GsActions 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 Action，用于检查提交信息是否符合预设的正则表达式模式。以下是项目的目录结构及其说明：

.
├── .ddev
├── .github          # 存放GitHub Actions的工作流配置文件
│   ├── workflows
│   └── ...
├── __tests__        # 测试文件目录
├── dist             # 构建后的文件存放目录
├── src              # 源代码目录
│   ├── ...
├── .eslintrc.json   # ESLint配置文件
├── .gitattributes   # Git属性配置文件
├── .gitignore       # Git忽略文件
├── .prettierrc.json # Prettier配置文件
├── CODE_OF_CONDUCT.md # 行为准则文件
├── LICENSE          # 许可证文件
├── README.md        # 项目说明文件
├── action.yml       # GitHub Action的配置文件
├── jest.config.js   # Jest配置文件
├── package-lock.json# npm依赖锁文件
├── package.json     # npm包配置文件
└── tsconfig.json    # TypeScript配置文件

2. 项目的启动文件介绍

本项目的主要启动文件是位于根目录下的 action.yml 文件。这个文件定义了GitHub Action的基本信息，包括它的名称、描述、入口点等信息。以下是 action.yml 的一个示例：

name: 'gsactions/commit-message-checker'
description: 'GitHub Action that checks commit messages of pushes and pull request against a regex pattern'
inputs:
  pattern:
    description: 'The regex pattern to match the commit messages against'
    required: true
  flags:
    description: 'The regex flags to use'
    default: 'gm'
  ...
runs:
  using: 'node12'
  main: './src/commit-message-checker.js'

在这个文件中，我们定义了Action的输入参数、使用的Node.js版本以及主执行文件。

3. 项目的配置文件介绍

项目的配置文件主要集中在 .github/workflows 目录下，这里定义了GitHub Actions的工作流。以下是一个名为 commit-message-checker.yml 的工作流配置文件示例：

name: 'Commit Message Check'

on:
  pull_request:
    types:
      - opened
      - edited
      - reopened
      - synchronize
  push:
    branches:
      - main
      - 'releases/*'

jobs:
  check-commit-message:
    name: 'Check Commit Message'
    runs-on: 'ubuntu-latest'
    steps:
      - name: 'Check Commit Type'
        uses: 'gsactions/commit-message-checker@v2'
        with:
          pattern: '\[[^]]+\] .+$'
          flags: 'gm'
          error: 'Your first line has to contain a commit type like "[BUGFIX]".'
        ...

在这个配置文件中，我们定义了触发工作流的条件（例如，当pull request被打开或编辑时），以及执行的工作（例如，检查提交信息的格式）。这里使用了本项目提供的GitHub Action，并且可以通过输入参数自定义正则表达式等设置。

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