git-cliff-action 使用教程
1. 项目的目录结构及介绍
git-cliff-action/
├── .github/
│ └── workflows/
│ └── main.yml
├── .gitignore
├── LICENSE
├── README.md
├── action.yml
├── cliff.toml
└── entrypoint.sh
- .github/workflows/main.yml: GitHub Actions 的工作流配置文件。
- .gitignore: 指定不需要跟踪的文件和目录。
- LICENSE: 项目的许可证文件。
- README.md: 项目的说明文档。
- action.yml: GitHub Actions 的自定义动作配置文件。
- cliff.toml: 项目的配置文件。
- entrypoint.sh: 项目的启动脚本。
2. 项目的启动文件介绍
entrypoint.sh 是项目的启动脚本,负责执行主要的操作。以下是该文件的基本内容:
#!/bin/sh -l
sh -c "echo Hello world my name is $INPUT_MY_NAME"
该脚本接收一个输入参数 MY_NAME
,并输出一条问候语。
3. 项目的配置文件介绍
cliff.toml 是项目的配置文件,用于配置 git-cliff 的行为。以下是该文件的基本内容:
[git-cliff]
tag_pattern = "v[0-9]*"
commit_parsers = [
{ message = "feat", changelog = "Features" },
{ message = "fix", changelog = "Bug Fixes" },
{ message = "perf", changelog = "Performance Improvements" },
{ message = "refactor", changelog = "Code Refactoring" },
{ message = "docs", changelog = "Documentation" },
{ message = "style", changelog = "Styles" },
{ message = "test", changelog = "Tests" },
{ message = "chore", changelog = "Chores" },
{ message = "ci", changelog = "Continuous Integration" }
]
该配置文件定义了标签模式和提交消息的解析规则,用于生成变更日志。
以上是 git-cliff-action
项目的基本使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助!