GitHub任务列表完成检查工具教程

GitHub任务列表完成检查工具教程

github-task-list-completedGitHub - Task list completed PR check项目地址:https://gitcode.com/gh_mirrors/gi/github-task-list-completed

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

github-task-list-completed/
├── .github/
│   └── workflows/
├── docs/
├── src/
│   ├── index.js
│   ├── task-list-checker.js
│   └── utils.js
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── yarn.lock

• .github/workflows: 包含GitHub Actions的工作流配置文件。
• docs: 存放项目文档。
• src: 项目的主要源代码文件夹。
  • index.js: 项目的入口文件。
  • task-list-checker.js: 任务列表检查的主要逻辑。
  • utils.js: 工具函数。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目的依赖和脚本配置。
• yarn.lock: Yarn包管理器的锁定文件。

2. 项目的启动文件介绍

项目的启动文件是src/index.js。这个文件负责初始化任务列表检查工具，并监听GitHub的Webhook事件，以便在拉取请求中检查任务列表的完成情况。

// src/index.js
const express = require('express');
const bodyParser = require('body-parser');
const { checkTaskList } = require('./task-list-checker');

const app = express();
app.use(bodyParser.json());

app.post('/webhook', async (req, res) => {
  const result = await checkTaskList(req.body);
  res.status(200).send(result);
});

const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

3. 项目的配置文件介绍

项目的配置文件主要是package.json，它包含了项目的依赖、脚本和其他元数据。

{
  "name": "github-task-list-completed",
  "version": "1.0.0",
  "description": "GitHub task list completed PR check",
  "main": "src/index.js",
  "scripts": {
    "start": "node src/index.js",
    "test": "jest"
  },
  "dependencies": {
    "express": "^4.17.1",
    "body-parser": "^1.19.0"
  },
  "devDependencies": {
    "jest": "^26.6.3"
  },
  "license": "MIT"
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目的入口文件。
• scripts: 可执行的脚本命令。
• dependencies: 项目运行时的依赖。
• devDependencies: 开发时的依赖。
• license: 项目许可证。

github-task-list-completedGitHub - Task list completed PR check项目地址:https://gitcode.com/gh_mirrors/gi/github-task-list-completed