我应该使用 gitignore 或 "your-api-key-here" 来隐藏 Github 上的 api 密钥吗？

Question

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

我发现的两种方法是

1. 使用.gitignore隐藏包含敏感信息的文件
2. 简单地将API密钥值改变为"；YOUR-API-KEY-HERE(优-爱-凯伊-赫雷(；然后上传到Github。就像这样：

ApiKey="；YOUR-API-KEY-HERE(优-爱-凯伊-赫雷(；

问题

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

在哪些情况下我应该使用Gitignore或"；YOUR-API-KEY-HERE(优-爱-凯伊-赫雷(；方法

Answer 1

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

您可以安全地将您的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变量。

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