Django SECRET_KEY 设置在 github 工作流中不能为空

Question

我有一个 Django 的 GitHub 工作流，当它要迁移数据库时，它给出了错误

django.core.exceptions.ImproperlyConfigured: The SECRET_KEY setting must not be empty.

密钥存储在.env 文件中并加载

from dotenv import load_dotenv
load_dotenv()
from pathlib import Path
env_path = Path('.') / '.env'
load_dotenv(dotenv_path=env_path)
SECRET_KEY = os.getenv("secret_key")

这是文件树

C:.
|   db.sqlite3
|   manage.py
|
\---djangosite
    |   .env
    |   asgi.py
    |   settings.py
    |   urls.py
    |   wsgi.py
    |   __init__.py
    |
    \---__pycache__
        ...

这是manage.py，它是从settings.py 加载.env 代码的常规django 代码

#!/usr/bin/env python
"""Django's command-line utility for administrative tasks."""
from dotenv import load_dotenv
load_dotenv()
from pathlib import Path
env_path = Path('.') / '.env'
load_dotenv(dotenv_path=env_path)
import os
import sys


def main():
    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'djangosite.settings')
    try:
        from django.core.management import execute_from_command_line
    except ImportError as exc:
        raise ImportError(
            "Couldn't import Django. Are you sure it's installed and "
            "available on your PYTHONPATH environment variable? Did you "
            "forget to activate a virtual environment?"
        ) from exc
    execute_from_command_line(sys.argv)


if __name__ == '__main__':
    main()

当我在我的 PC 上运行 manage.py 时，它会加载密钥并运行服务器，但 GitHub 给出了上述错误。 如何阻止此错误发生？

Answer 1

如果您已将SECRET_KEY 存储在系统的环境变量中，那么对于 GitHub 工作流程，您可以在 YAML 文件中添加一个 dummy 环境变量。

settings.py 应如下所示

import os
...
SECRET_KEY = os.environ.get('SECRET_KEY') # Or the name by which you stored environment variable
...

步骤如下：

第 1 步： 生成一个虚拟 SECRET_KEY。您可以自己创建它

import secrets
print(secrets.token_hex(25))

或者从像this这样的网站生成。

第 2 步：在您的 .github/workflows YAML 文件（例如 django.yml）中，添加此

steps:
...
- name: Run Tests
  env: 
    SECRET_KEY: your-genereated-secret_key
  run: |
    python manage.py test

然后，在您的本地环境、生产环境和 GitHub 工作流程中使用相同版本的代码，一切都会正常工作。

Answer 2

当您运行python manage.py runserver 8000 时，您使用的是manage.py，它将您的DJANGO_SETTINGS_MODULE 设置为settings。您的根目录中似乎没有settings.py，所以manage.py中的这一行：

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")

应该变成：

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "Your-App-Name.settings")

正如您在 wsgi.py 文件中所做的那样。

您也可以在这里查看其他可能的solutions。