《Turbo 项目配置 GitHub Actions 缓存》启动和配置文档

1. 项目目录结构及介绍

在 Turbo 项目中，目录结构通常如下所示：

turbo/
├── .github/              # 存放 GitHub Actions 工作流文件
│   ├── workflows/        # 工作流文件所在的目录
│   └── actions/          # 自定义 GitHub Actions 所在的目录（如果有的话）
├── package.json          # 项目依赖和配置
├── package-lock.json     # 项目依赖锁定文件
├── src/                  # 源代码目录
│   ├── index.js          # 源代码入口文件
│   └── ...               # 其他源代码文件
├── dist/                 # 编译后的代码目录
├── .gitignore            # 指定 Git 忽略的文件和目录
└── ...                   # 其他项目相关文件

• .github/: 这个目录包含了所有与 GitHub Actions 相关的工作流文件和自定义动作脚本。
• src/: 这是存放项目源代码的地方。
• dist/: 项目编译或构建后的文件通常会放在这个目录下。
• package.json 和 package-lock.json: 这两个文件定义了项目的依赖项，package-lock.json 用于锁定依赖版本以确保构建的一致性。
• .gitignore: 这个文件用于定义哪些文件和目录应该被 Git 忽略。

2. 项目的启动文件介绍

项目的启动文件通常位于 src/ 目录下的 index.js 文件。这个文件是项目的入口点，它定义了应用程序的启动逻辑。以下是一个简单的 index.js 文件示例：

// src/index.js

const express = require('express');
const app = express();
const PORT = process.env.PORT || 3000;

app.get('/', (req, res) => {
  res.send('Hello, Turbo!');
});

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

在上面的代码中，我们创建了一个简单的 Express 服务器，当访问根路径时会返回 "Hello, Turbo!"。

3. 项目的配置文件介绍

项目的配置文件主要是 .github/workflows/caching.yml。这个 YAML 文件定义了 GitHub Actions 的工作流，用于设置缓存以加速构建过程。以下是一个配置缓存的示例：

# .github/workflows/caching.yml

name: Cache Turbo

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  cache:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Setup Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'

      - name: Cache Node modules
        uses: actions/cache@v2
        with:
          path: ~/.npm
          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-node-

      - name: Install Dependencies
        run: npm install

      - name: Build
        run: npm run build

在这个配置文件中，我们定义了一个名为 cache 的工作流，它在每次推送或拉取请求到 main 分支时都会运行。它包括以下步骤：

1. 检出代码。
2. 设置 Node.js 环境。
3. 缓存 Node 模块，以便下次构建时可以更快地安装依赖项。
4. 安装依赖项。
5. 执行构建过程。

这个缓存策略是基于 package-lock.json 文件的哈希值来确定的，以确保只有当依赖项发生变化时才会更新缓存。