我应该使用 gitignore 还是“your-api-key-here”来隐藏 Github 上的 api 密钥？

问题描述

我完成了一个包含 API 密钥的项目，我想将其上传到 Github。我要小心不要在 Github 上公开 API 密钥。

我发现的两种方法是

1. 使用 .gitignore 隐藏包含敏感信息的文件
2. 在上传到 Github 之前，只需将 API 密钥值更改为“YOUR-API-KEY-HERE”。像这样：

ApiKey="YOUR-API-KEY-HERE"

问题

如果包含我的 API 密钥的文件在 gitignore 中“隐藏”并且我将我的项目上传到 Github，这是否会导致我的项目无法被任何下载它的人正常运行，因为该项目找不到“隐藏”的 API钥匙？如果有人在 Github 上查看我的项目，他们是否无法访问“隐藏”文件？

在哪些情况下我应该使用 Gitignore 或“YOUR-API-KEY-HERE”方法？

解决方法

通常，下载您代码的其他人需要获取他们自己的 API 密钥才能运行您的项目（取决于您的项目的设置方式）。然后，他们会将 API 密钥添加到他们的 fork（作为秘密）或他们机器上的本地存储库。

您可以通过以下方式将您的 API 密钥作为“秘密”安全地存储在您的 GitHub 存储库中：

1. Settings 标签位于您的存储库顶部
2. Secrets 选项靠近最左侧列的底部
3. New Repository Secret
4. 在 Name 字段中输入 API 密钥的变量名称

示例：SECRET_API_KEY

5. 在 Value 字段中输入您的 API 密钥值。
6. Add Secret

现在您只需要确保您的项目引用了 SECRET_API_KEY 变量。

注意：其他人将无法访问此 Secret。只有作为回购所有者的您才能访问此密钥。其他开发者需要获取他们自己的 API 密钥并将其作为秘密存储在他们项目的分支中。