GitHub Actions 设置 Node.js 版本教程

1. 项目介绍

setup-node 是一个 GitHub Actions 项目，旨在帮助用户在 GitHub Actions 工作流中设置特定的 Node.js 版本。通过使用 setup-node，用户可以轻松地在 CI/CD 流程中指定所需的 Node.js 版本，并确保在不同的运行环境中使用一致的 Node.js 版本。

该项目的主要功能包括：

• 可选地下载和缓存指定版本的 Node.js 并将其添加到 PATH 中。
• 可选地缓存 npm/yarn/pnpm 依赖项。
• 注册问题匹配器以捕获错误输出。
• 配置 GPR（GitHub Packages Registry）或 npm 的认证。

2. 项目快速启动

以下是一个简单的示例，展示如何在 GitHub Actions 工作流中使用 setup-node 来设置 Node.js 版本。

示例工作流文件

name: Node.js CI

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - name: 设置 Node.js 版本
      uses: actions/setup-node@v4
      with:
        node-version: '18'
    - run: npm install
    - run: npm test

解释

1. uses: actions/checkout@v4: 检出代码库。
2. uses: actions/setup-node@v4: 使用 setup-node 动作来设置 Node.js 版本。
   • node-version: '18': 指定要使用的 Node.js 版本为 18。
3. run: npm install: 安装项目依赖。
4. run: npm test: 运行测试。

3. 应用案例和最佳实践

应用案例

• 多版本测试: 在同一个工作流中测试多个 Node.js 版本，确保代码在不同版本下都能正常运行。

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [14, 16, 18]

    steps:
    - uses: actions/checkout@v4
    - name: 设置 Node.js 版本
      uses: actions/setup-node@v4
      with:
        node-version: ${{ matrix.node-version }}
    - run: npm install
    - run: npm test

最佳实践

• 缓存依赖项: 使用 cache 输入来缓存 npm/yarn/pnpm 依赖项，加快构建速度。

- uses: actions/setup-node@v4
  with:
    node-version: '18'
    cache: 'npm'

• 检查最新版本: 使用 check-latest 选项来确保使用最新的 LTS 版本。

- uses: actions/setup-node@v4
  with:
    node-version: '18'
    check-latest: true

4. 典型生态项目

• actions/checkout: 用于检出代码库的 GitHub Actions 动作。
• actions/cache: 用于缓存依赖项的 GitHub Actions 动作。
• actions/github-script: 用于在 GitHub Actions 中执行 JavaScript 脚本的动作。

通过结合这些生态项目，可以构建更加复杂和高效的 CI/CD 工作流。