GitHub Action MetaData

创建 action 和使用 workflows 是两个不同的操作

• 使用 workflows 是一个自动化的过程
  • 由 .github/workflows 下的 yaml 文件定义，可以是事件，事件或者手动触发
• 创建 action 可以创建自己的操作或者使用和自定义 github 社区分享的操作
  • 在操作主要元数据文件按来定义操作的输入，输出和主要进入点。元数据的文件名必须要 action.yml

JavaScript 操作

• 这里尝试演示一个使用 actions 元数据去编写一个 Issue 自动提交

GitHub Actions 的元数据语法

• 在根目录下创建一个 action.yml 文件，并且文件名称只能是这个

name: 'test one create issues'
description: 'test create issues'
inputs:
  token:
    description: 'ACTION_ACCESS'
    required: true
    default: ${{github.token}}
  repoURL:
    description: 'repo'
    default: ${{github.repositoryUrl}}
  path:
    description: 'path'
    default: ${{github.action_path}}
runs:
  using: 'node16'
  main: 'index.mjs'

• inputs 是指定从工作流（workflows）中获取对应的输入字段，token 是工作流（workflows）中的名称
• runs：指定的操作，这里必须指定是 JavaScript 操作，复合操作还是 Docker 容器操作以及操作的执行方式

  • using：必要。指定 main 中代码的执行环境

  • main：必要。包含操作的文件

  • pre：允许你在 main 操作开始之前，在作业开始时运行脚本

  • pre-if：允许定义 pre 操作执行的条件。pre 操作只会在满足 pre-if 中的条件运行。如果未设置，则 pre-if 默认使用 always()

    pre: 'cleanup.js'
    pre-if: runner.os == 'linux'
    

  • post：允许你在 main 操作完成后，在作业结束时运行脚本

    • 例如，你可以使用 post 终止某些进程或删除不需要的文件

  • post-if：允许定义的 post 操作执行的条件，和 pre-if 类似

    runs:
      using: 'node16'
      main: 'index.js'
      post: 'cleanup.js'
      post: 'cleanup.js'
      post-if: runner.os == 'linux'
    

  • steps：操作中的步骤。这里是符合操作，using 必须指定-->using:"composite"

    • shell：如果有 run 操作，必须指定 shell

    runs:
      using: "composite"
      steps:
        - run: ${{ github.action_path }}/test/script.sh
          shell: bash
    

    ...

编写 index.js 文件

• 下载 octokit:pnpm add octokit，这里需要使用这个包对 github 暴露的接口进行操作

• 下载 @actions/core:pnpm add @actions/core，该包提供一个接口，用于工作流程命令，输入和输出变量，退出状态以及调试

  import { Octokit } from "octokit";
  import { getInput } from "@actions/core";
  import dayjs from "dayjs";
  const token = getInput("token");
  const octokit = new Octokit({
    auth: token,
  });
  await octokit.rest.issues.create({
    owner: "fwqaaq",
    repo: "demo",
    title: getTitle(),
    body: getBody(),
  });
  
  function getTitle() {
    return dayjs().format("YYYY-MM-DD");
  }
  
  function getBody() {
    return "* test a new task";
  }
  

• 这里的 auth:token，是获取的 workflows 中 with 关键字设置的输入参数

编写工作流 workflows

on: [push]

jobs:
  test_one_issues:
    runs-on: ubuntu-latest
    name: create issues action
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: node
        uses: actions/setup-node@v3.0.0
        with:
          node-version: "16.x"
      - name: install
        run: npm install
      - name: create issues
        uses: ./
        with:
          token: ${{secrets.ACTION_ACCESS}}

• 最后一个 create issues 中的 uses:./ 就是指定根路径下自己的 action 元数据 action.yml
• with 就是传给 action.yml 的键值对。并且在 index.js 中使用了 @action/core 中的 getInput 获取

如果只想打包 dist 文件到仓库，可以使用 @vercel/ncc 这个包，这个包只会把引用的模块加载到 dist 包中

• 下载 ncc 包：pnpm add @vercel/ncc
• 然后添加脚本："build": "ncc build index.mjs --license licenses.txt"
• 运行之后就可以使用 dist 包每天更新 issue