一套灵活优雅的 Github 工作流，开放共享，便捷你的模块开发

前端

2024-02-17 02:19:45

在 NPM 模块开发过程中，我们经常会遇到一些重复性的搭建工作，例如：

创建项目结构
初始化 Git 仓库
安装依赖项
编写测试用例
生成文档
部署到 NPM

这些重复性的工作不仅浪费时间，还会分散我们的注意力，让我们无法专注于模块的核心功能开发。

为了解决这个问题，我整理了一套优雅的 Github 工作流。这套工作流可以帮助我们自动完成上述重复性的工作，让我们可以专注于模块的核心功能开发。

这套工作流的核心是使用 NPM 脚本。通过 NPM 脚本，我们可以定义一些自动化任务，并在需要的时候运行这些任务。

例如，我们可以定义一个名为 build 的 NPM 脚本，这个脚本可以自动完成以下任务：

编译代码
运行测试用例
生成文档
打包模块

我们可以通过运行 npm run build 命令来运行这个脚本。

除了 build 脚本之外，我们还可以定义其他 NPM 脚本，例如 test 脚本、doc 脚本、deploy 脚本等。这些脚本可以帮助我们自动完成其他重复性的工作。

这套工作流不仅可以帮助我们提高开发效率，还可以帮助我们保持项目的一致性。通过使用这套工作流，我们可以确保所有的模块都具有相同的结构、相同的测试用例、相同的文档和相同的部署方式。

如果你也喜欢写 NPM 模块，不妨试用一下这套工作流工具，助你提高开发效率。

工作流特点

这套工作流具有以下特点：

自动化： 这套工作流可以自动完成重复性的工作，如创建项目结构、初始化 Git 仓库、安装依赖项、编写测试用例、生成文档和部署到 NPM。
灵活性： 这套工作流可以根据需要进行定制。你可以添加或删除 NPM 脚本，以满足你的具体需求。
一致性： 这套工作流可以帮助你保持项目的一致性。通过使用这套工作流，你可以确保所有的模块都具有相同的结构、相同的测试用例、相同的文档和相同的部署方式。

如何使用

要使用这套工作流，你需要先安装 Node.js 和 NPM。然后，你可以在你的项目中创建一个名为 .github/workflows 的目录，并在该目录中创建一个名为 main.yml 的文件。

在 main.yml 文件中，你可以定义你的工作流。一个示例如下：

name: CI/CD

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '16'
      - run: npm install
      - run: npm run build

  test:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '16'
      - run: npm install
      - run: npm run test

  deploy:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '16'
      - run: npm install
      - run: npm run deploy