GitHub Commenter 使用教程

1. 项目的目录结构及介绍

GitHub Commenter 是一个命令行工具，用于在 GitHub 上创建和管理评论。以下是其基本目录结构：

github-commenter/
├── README.md
├── dist/
│   └── bin/
│       └── github-commenter
├── docs/
│   └── ...
├── examples/
│   └── ...
├── scripts/
│   └── ...
├── src/
│   └── ...
└── Makefile

• README.md: 项目介绍和使用说明。
• dist/bin/github-commenter: 编译后的可执行文件。
• docs/: 项目文档。
• examples/: 使用示例。
• scripts/: 构建和部署脚本。
• src/: 源代码目录。
• Makefile: 构建和测试的 Makefile 文件。

2. 项目的启动文件介绍

GitHub Commenter 的启动文件是 dist/bin/github-commenter。这是一个编译后的二进制文件，可以通过命令行直接运行。以下是一个基本的启动命令示例：

./dist/bin/github-commenter \
  -token XXXXXXXXXXXXXXXX \
  -owner cloudposse \
  -repo github-commenter \
  -type pr \
  -number 2 \
  -format "{{ }}" \
  -comment "New Pull Request comment"

3. 项目的配置文件介绍

GitHub Commenter 主要通过命令行参数进行配置。以下是一些常用的配置参数：

• -token: GitHub 访问令牌。
• -owner: GitHub 仓库所有者。
• -repo: GitHub 仓库名称。
• -type: 评论类型，可以是 commit, pr, issue, pr-review, 或 pr-file。
• -number: Pull Request 或 Issue 编号。
• -format: 评论格式模板。
• -comment: 评论内容。

完整的配置参数列表可以在项目的 GitHub 页面 上找到。

参考资料

• GitHub Commenter 项目地址
• GitHub Commenter 使用文档