我应该提交一个空的.env文件吗？

Question

我有一个存储数据库信息的.env文件，我要在GitHub上发布我的项目。因此，我的问题是，我应该提交一个空的.env文件，只包含所需的密钥，但没有值，这样其他人就可以理解如何填写它（并可能将其添加到.gitignore文件中）吗？

例如，如果我的.env文件看起来像这样：

DB_HOST=localhost
DB_USER=root
DB_PASS=s1mpl3

我应该像这样提交它，还是干脆不提交？

DB_HOST=
DB_USER=
DB_PASS=

提前感谢。

- DoceAzedo

Answer 1

你应该提交，但使用另一个名称，例如 .env.example。 通过这个空的环境变量文件，其他团队成员可以了解环境变量的格式，并自行填写。

- Chuong Tran

---

不错！顺便说一下，这解释了WordPress中的wp-config-sample.php文件。 - DoceAzedo

Answer 2

不行。如果你将.env添加到Git中，任何对.env的未来更改都会被Git看到。它们可能会被意外提交。

将Git正在跟踪的文件添加到.gitignore中没有影响。

一个gitignore文件指定了Git应该忽略的有意义的未跟踪文件。已经由Git跟踪的文件不受影响。

例如，我添加并提交了一个空的.env文件，然后进行了修改。

$ cat .gitignore 
.env

$ git status
On branch master
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
    modified:   .env

no changes added to commit (use "git add" and/or "git commit -a")

$ git diff
diff --git a/.env b/.env
index 4a263e9..94d2d70 100644
--- a/.env
+++ b/.env
@@ -1,3 +1,3 @@
-DB_HOST=
-DB_USER=
-DB_PASS=
+DB_HOST=host
+DB_USER=user
+DB_PASS=pass

将 .env 添加到你的 .gitignore 中，并不要跟踪它。在安装和配置文档中记录你的环境变量。

- Schwern