本文详细介绍了如何使用javascript和github rest api程序化地在github仓库中添加或更新文件。核心内容包括：利用个人访问令牌（pat）进行认证，将文件内容进行base64编码，以及在更新现有文件时必须提供文件的sha值。通过分步指南和示例代码，读者将学会如何先通过get请求获取文件sha，再通过put请求提交文件内容，从而实现自动化文件管理。
使用JavaScript和GitHub API程序化管理仓库文件
在自动化工作流程中，有时我们需要通过代码直接向GitHub仓库添加或更新文件。GitHub REST API提供了一套强大的接口，允许我们以编程方式执行这些操作。本文将指导您如何使用JavaScript的fetch API与GitHub API交互，实现文件的上传和更新。
1. GitHub API认证与基础概念
与GitHub API交互需要进行认证。最常用的方法是使用个人访问令牌（Personal Access Token, PAT）。PAT应具有足够的权限来操作目标仓库（例如，repo 范围权限）。
关键API端点：
- 获取文件内容（GET）： GET /repos/{owner}/{repo}/contents/{path}
- 创建或更新文件内容（PUT）： PUT /repos/{owner}/{repo}/contents/{path}
2. 文件内容编码：Base64
GitHub API要求所有文件内容在提交时都必须经过Base64编码。这是为了确保各种类型的文件内容都能安全地通过JSON传输。在JavaScript中，您可以使用btoa()函数将字符串编码为Base64格式。
示例：
立即学习“Java免费学习笔记（深入）”；
const originalContent = "这是要上传的文件内容。"; const encodedContent = btoa(originalContent); // 编码为 Base64 console.log(encodedContent); // 输出类似 "5pys6ZqP5YaF5a655Y+C5LqL5Zmo5YaF5a6577yB"
3. 更新文件时的SHA参数
这是在更新现有文件时最容易出错的地方。GitHub API在PUT请求中要求提供被替换文件的blob SHA。如果文件是首次创建，则不需要此参数。但如果文件已存在，并且您尝试更新它而不提供sha参数，API将拒绝请求。
要获取文件的SHA值，您需要先执行一个GET请求来检索目标文件的元数据。如果文件存在，响应中将包含sha属性。
多奥淘宝客程序免费版拥有淘宝客站点的基本功能，手动更新少，管理简单等优点，适合刚接触网站的淘客们，或者是兼职做淘客们。同样拥有VIP版的模板引擎技 术、强大的文件缓存机制，但没有VIP版的伪原创跟自定义URL等多项创新的搜索引擎优化技术，除此之外也是一款高效的API数据系统实现无人值守全自动 化运行的淘宝客网站程序。4月3日淘宝联盟重新开放淘宝API申请，新用户也可使用了
4. 实现文件上传与更新的JavaScript函数
我们将创建一个异步JavaScript函数，它首先尝试获取文件的当前状态（包括SHA值），然后根据情况创建或更新文件。
/**
* 上传或更新GitHub仓库中的文件。
* @param {string} owner - 仓库所有者（用户名或组织名）。
* @param {string} repo - 仓库名称。
* @param {string} path - 文件在仓库中的路径。
* @param {string} content - 要上传的原始文件内容（未编码）。
* @param {string} message - 提交信息。
* @param {string} token - GitHub个人访问令牌（PAT）。
*/
async function uploadOrUpdateGitHubFile(owner, repo, path, content, message, token) {
const apiUrl = `https://api.github.com/repos/${owner}/${repo}/contents/${path}`;
// 1. 尝试获取现有文件信息以获取SHA
let existingFileSha = undefined;
try {
const getResponse = await fetch(apiUrl, {
method: 'GET',
headers: {
'Accept': 'application/vnd.github+json',
'Authorization': `Bearer ${token}`
}
});
if (getResponse.ok) {
const existingFileData = await getResponse.json();
existingFileSha = existingFileData.sha;
console.log(`文件 '${path}' 已存在，SHA为: ${existingFileSha}`);
} else if (getResponse.status === 404) {
console.log(`文件 '${path}' 不存在，将创建新文件。`);
} else {
// 处理其他GET请求错误
const errorData = await getResponse.json();
throw new Error(`获取文件信息失败: ${getResponse.status} - ${errorData.message}`);
}
} catch (error) {
console.error("获取文件SHA时发生错误:", error);
// 如果是网络错误，或者权限不足导致无法获取，这里会捕获
// 我们可以选择在此处停止或尝试继续（如果确定是创建新文件）
}
// 2. 准备PUT请求体
const encodedContent = btoa(content); // 将文件内容编码为Base64
const putBody = {
message: message,
content: encodedContent,
};
// 如果文件已存在，则添加SHA参数
if (existingFileSha) {
putBody.sha = existingFileSha;
}
// 3. 执行PUT请求创建或更新文件
try {
const putResponse = await fetch(apiUrl, {
method: 'PUT',
headers: {
'Accept': 'application/vnd.github+json',
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json' // 明确指定内容类型
},
body: JSON.stringify(putBody),
});
if (putResponse.ok) {
const result = await putResponse.json();
console.log("文件操作成功:", result);
return result;
} else {
const errorData = await putResponse.json();
throw new Error(`文件操作失败: ${putResponse.status} - ${errorData.message}`);
}
} catch (error) {
console.error("上传/更新文件时发生错误:", error);
throw error; // 重新抛出错误以便调用者处理
}
}
// 示例调用：
// 假设您有一个HTML按钮，点击时调用此函数
/*
*/
async function handleFileUpload() {
const myOwner = 'YOUR_GITHUB_USERNAME'; // 替换为您的GitHub用户名
const myRepo = 'YOUR_REPOSITORY_NAME'; // 替换为您的仓库名
const myPath = 'my-automated-file.txt'; // 文件在仓库中的路径
const myContent = 'Hello, GitHub! This is an automated update.'; // 要上传的文件内容
const myMessage = 'Automated file update via JS'; // 提交信息
const myToken = 'YOUR_GITHUB_PERSONAL_ACCESS_TOKEN'; // 替换为您的PAT
// 警告：在客户端JS中直接暴露PAT存在安全风险！
// 生产环境中，应将此操作放在后端服务器进行，或使用OAuth Apps/GitHub Apps。
try {
await uploadOrUpdateGitHubFile(myOwner, myRepo, myPath, myContent, myMessage, myToken);
alert('文件上传/更新成功！请检查您的GitHub仓库。');
} catch (error) {
alert('文件上传/更新失败: ' + error.message);
}
}5. 注意事项与安全实践
-
个人访问令牌（PAT）的安全：
-
错误处理：
- 在实际应用中，您需要更健壮的错误处理机制，包括网络错误、API响应错误（例如权限不足、仓库不存在等）。
- GitHub API有严格的速率限制。频繁的请求可能会导致暂时被阻止。请查阅GitHub API文档了解速率限制策略。
-
权限管理：
- 确保您的个人访问令牌（PAT）拥有对目标仓库进行内容读写（repo 范围）的必要权限。
-
异步操作：
- fetch API是异步的，因此使用async/await可以使代码更易读和维护。确保您的调用函数也处理了异步操作。
总结
通过上述步骤，您已经学会了如何使用JavaScript和GitHub REST API程序化地管理仓库文件。关键在于正确处理认证、文件内容Base64编码以及在更新文件时提供正确的SHA值。虽然这种方法在自动化任务中非常有用，但务必牢记安全实践，尤其是在处理个人访问令牌时。在生产环境中，建议将此类敏感操作移至安全的后端环境执行。
