Mattermost GitHub 插件使用教程
1. 项目的目录结构及介绍
mattermost-plugin-github/
├── github/
│ ├── workflows/
│ │ ├── build
│ │ ├── images
│ │ └── server
│ ├── editorconfig
│ ├── gitignore
│ ├── golangci.yml
│ ├── nvmrc
│ ├── CHANGELOG.md
│ ├── LICENSE
│ ├── Makefile
│ ├── README.md
│ ├── go.mod
│ ├── go.sum
│ └── plugin.json
├── e2e/
│ └── playwright/
└── ...
目录结构介绍
-
github/: 主要代码目录,包含插件的核心逻辑。
- workflows/: 包含构建、镜像和服务器的相关配置文件。
- editorconfig: 编辑器配置文件。
- gitignore: Git 忽略文件配置。
- golangci.yml: GolangCI 配置文件。
- nvmrc: Node.js 版本管理配置文件。
- CHANGELOG.md: 项目变更日志。
- LICENSE: 项目许可证。
- Makefile: 项目构建和运行脚本。
- README.md: 项目说明文档。
- go.mod: Go 模块依赖文件。
- go.sum: Go 模块校验文件。
- plugin.json: 插件配置文件。
-
e2e/playwright/: 端到端测试目录,包含 Playwright 测试脚本。
2. 项目的启动文件介绍
项目的启动文件主要是 Makefile
,它包含了项目的构建、测试和运行命令。以下是一些常用的命令:
- make build: 构建项目。
- make test: 运行测试。
- make run: 启动项目。
3. 项目的配置文件介绍
项目的配置文件主要是 plugin.json
,它包含了插件的基本配置信息,如插件名称、版本、描述等。以下是一个示例配置:
{
"id": "com.mattermost.plugin.github",
"name": "GitHub Plugin",
"description": "This plugin allows users to fetch contributor data from GitHub via a slash command.",
"version": "1.0.0",
"min_server_version": "5.12.0",
"server": {
"executables": {
"linux-amd64": "server/dist/plugin-linux-amd64",
"darwin-amd64": "server/dist/plugin-darwin-amd64",
"windows-amd64": "server/dist/plugin-windows-amd64.exe"
}
}
}
配置文件介绍
- id: 插件的唯一标识符。
- name: 插件的名称。
- description: 插件的描述。
- version: 插件的版本号。
- min_server_version: 插件支持的最小 Mattermost 服务器版本。
- server: 包含插件的可执行文件路径,根据不同的操作系统提供不同的路径。
通过以上配置,可以确保插件在 Mattermost 服务器上正确运行。