求助：如何用Node.js将用户生成内容上传至GitHub仓库

前置准备 #

• 生成GitHub个人访问令牌（PAT）：在GitHub设置中创建，必须勾选repo权限（仅仓库权限即可，不要勾选不必要的权限）。
• 确定目标仓库的所有者（用户名/组织名）、仓库名称。

依赖选择 #

使用官方的@octokit/rest SDK，它封装了GitHub REST API，比直接发送HTTP请求更简洁可靠。安装命令：

npm install @octokit/rest

代码实现 #

以下是完整的上传/更新文件示例，支持创建新文件或更新已存在的文件：

const { Octokit } = require("@octokit/rest");

// 初始化Octokit，传入你的PAT
const octokit = new Octokit({
  auth: "YOUR_GITHUB_PAT",
});

/**
 * 上传文件到GitHub仓库
 * @param {string} repoOwner - 仓库所有者（用户名/组织名）
 * @param {string} repoName - 仓库名称
 * @param {string} filePath - 文件在仓库中的路径（如user-content/user123/notes.md）
 * @param {string|Buffer} content - 要上传的内容（文本或二进制数据）
 * @param {string} message - Git提交消息
 */
async function uploadUserContent(repoOwner, repoName, filePath, content, message) {
  try {
    // 先尝试获取文件，判断是否已存在
    const existingFile = await octokit.rest.repos.getContent({
      owner: repoOwner,
      repo: repoName,
      path: filePath,
    });

    // 文件存在，执行更新操作（需要传入文件的sha值）
    await octokit.rest.repos.createOrUpdateFileContents({
      owner: repoOwner,
      repo: repoName,
      path: filePath,
      message: message,
      content: Buffer.from(content).toString("base64"),
      sha: existingFile.data.sha,
    });
    console.log(`✅ 更新文件成功：${filePath}`);
  } catch (err) {
    if (err.status === 404) {
      // 文件不存在，执行创建操作
      await octokit.rest.repos.createOrUpdateFileContents({
        owner: repoOwner,
        repo: repoName,
        path: filePath,
        message: message,
        content: Buffer.from(content).toString("base64"),
      });
      console.log(`✅ 创建文件成功：${filePath}`);
    } else {
      console.error(`❌ 上传失败：${err.message}`);
      throw err;
    }
  }
}

// 使用示例：上传用户生成的文本内容
uploadUserContent(
  "your-github-username",
  "your-repo-name",
  "user-content/456/2024-05-20/post.md", // 按用户ID+日期划分路径，避免冲突
  "这是用户生成的帖子内容",
  "新增用户456的2024-05-20帖子"
);

关键注意事项 #

• 内容编码：GitHub API要求文件内容必须是Base64编码，所以用Buffer.from(content).toString("base64")处理文本或二进制数据。
• 路径规划：建议按用户ID、日期等维度划分目录（如user-content/{userId}/{date}/{filename}），避免不同用户的文件冲突。
• 速率限制：GitHub API免费版每小时允许5000次请求，若用户量较大，需处理限流逻辑（octokit默认会自动重试限流请求）。
• 大文件限制：此API仅支持上传≤100MB的文件，若需处理更大文件，需搭配Git LFS，但用户生成内容一般无需此场景。
• 安全问题：不要硬编码PAT到代码中，建议通过环境变量（如process.env.GITHUB_PAT）读取，避免泄露。

内容的提问来源于stack exchange，提问作者Manwil Zaki