我应该使用 gitignore 还是 "your-api-key-here" 来隐藏 Github 上的 api 键？

Should I use gitignore or "your-api-key-here" to hide api key on Github?

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

上暴露 API 键

我发现的两种方法是

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

ApiKey="YOUR-API-KEY-HERE"

问题

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

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

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

您可以安全地将 API 密钥作为“秘密”存储在您的 GitHub 存储库中，方法是：

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

示例：SECRET_API_KEY

  1. 在 Value 字段中输入您的 API 键值。
  2. Add Secret

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

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