WIP GitHub Action 使用教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00033/article/details/139915406

WIP GitHub Action 使用教程

action The WIP GitHub Action 项目地址: https://gitcode.com/gh_mirrors/action3/action

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

WIP GitHub Action 项目的目录结构如下：

.
├── github
│   └── workflows
├── dist
├── test
├── .gitignore
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── action.yml
├── index.js
├── package-lock.json
└── package.json

目录结构介绍

github/workflows: 存放 GitHub Actions 的工作流文件。
dist: 存放编译后的文件。
test: 存放测试文件。
.gitignore: 指定 Git 忽略的文件和目录。
CODE_OF_CONDUCT.md: 项目的行为准则。
LICENSE: 项目的开源许可证。
README.md: 项目的介绍和使用说明。
action.yml: GitHub Action 的配置文件。
index.js: 项目的主入口文件。
package-lock.json: 锁定项目依赖的版本。
package.json: 项目的依赖和脚本配置文件。

2. 项目的启动文件介绍

项目的启动文件是 index.js。这个文件是 WIP GitHub Action 的核心逻辑所在，负责检查 Pull Request 的标题是否包含 "WIP"，并根据检查结果设置 Pull Request 的状态。

index.js 文件内容概述

// index.js 文件内容概述
const core = require('@actions/core');
const github = require('@actions/github');

async function run() {
  try {
    const title = github.context.payload.pull_request.title;
    const isWip = title.includes('WIP');

    if (isWip) {
      core.setFailed('Work in progress');
    } else {
      core.info('Ready for review');
    }
  } catch (error) {
    core.setFailed(error.message);
  }
}

run();

功能介绍

检查标题: 通过 github.context.payload.pull_request.title 获取 Pull Request 的标题。
判断是否为 WIP: 使用 title.includes('WIP') 判断标题是否包含 "WIP"。
设置状态: 如果标题包含 "WIP"，则设置状态为失败，否则设置为成功。

3. 项目的配置文件介绍

项目的配置文件主要包括 action.yml 和 package.json。

action.yml

action.yml 是 GitHub Action 的配置文件，定义了 Action 的输入、输出、运行环境等信息。

# action.yml 文件内容概述
name: 'WIP'
description: 'Sets a pull request status to pending if the title includes "WIP"'
author: 'wip'
inputs:
  GITHUB_TOKEN:
    description: 'GitHub token'
    required: true
runs:
  using: 'node12'
  main: 'index.js'

配置项介绍

name: Action 的名称。
description: Action 的描述。
author: Action 的作者。
inputs: 定义 Action 的输入参数，例如 GITHUB_TOKEN。
runs: 定义 Action 的运行环境，使用 node12，并指定主入口文件为 index.js。

package.json

package.json 是 Node.js 项目的配置文件，定义了项目的依赖、脚本等信息。

{
  "name": "wip-action",
  "version": "1.0.0",
  "description": "A GitHub Action to set a pull request status to pending if the title includes 'WIP'",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "wip",
  "license": "Apache-2.0",
  "dependencies": {
    "@actions/core": "^1.2.6",
    "@actions/github": "^4.0.0"
  }
}