---

如何使用 GitHub 管理 Django 项目版本

在现代软件开发中，版本控制是不可或缺的一环。它不仅能帮助你跟踪代码变更、回溯历史版本，还能极大地促进团队协作。对于 Django 项目而言，结合 Git 和 GitHub 能够提供一套强大且高效的版本管理解决方案。本文将详细介绍如何初始化 Django 项目的 Git 仓库，并利用 GitHub 进行版本控制与协作。

1. 为什么选择 Git 和 GitHub？

• Git: 作为一个分布式版本控制系统 (DVCS)，Git 允许你在本地拥有完整的代码历史，即使没有网络也能进行提交、分支、合并等操作。它的高性能和灵活性使其成为开发者的首选。
• GitHub: 作为全球最大的代码托管平台之一，GitHub 提供了一个基于 Git 的在线仓库服务。它不仅提供了代码存储，还集成了项目管理、协作工具（如 Pull Requests、Issues、Code Review）和持续集成/持续部署 (CI/CD) 功能，极大地简化了团队开发流程。

2. 前提条件

在开始之前，请确保你已具备以下条件：

1. 安装 Git: 访问 git-scm.com 下载并安装 Git。
2. GitHub 账户: 如果没有，请在 github.com 注册一个账户。
3. 已创建的 Django 项目：或者准备创建一个新的 Django 项目。

3. 初始化 Git 仓库并创建 .gitignore 文件

假设你已经有了一个 Django 项目，或者刚刚使用 django-admin startproject myproject 命令创建了一个新项目。

1. 进入项目根目录:
   bash
cd myproject/

2. 初始化 Git 仓库:
   bash
git init
   这会在你的项目目录下创建一个 .git 隐藏文件夹，用于存储所有的版本控制信息。

3. 创建 .gitignore 文件:
   Django 项目会生成一些不应该被版本控制的文件（如数据库文件、媒体文件、虚拟环境、敏感配置等）。在项目根目录下创建一个名为 .gitignore 的文件，并添加以下常用规则：

   “`gitignore

   Python

   .pyc
   pycache/
   .egg-info/
   .Python
   .venv/
   venv/
   env/
   pip-log.txt
   pip-delete-this-directory.txt

   Django specific

   .log
   .pot
   .mo
   .sqlite3 # SQLite database file
   media/ # User uploaded media files
   static_root/ # Collected static files

   IDE specific (e.g., VS Code)

   .vscode/
   .idea/

   Operating System

   .DS_Store
   Thumbs.db

   Sensitive configuration (very important!)

   .env
   config.ini
   local_settings.py
   ``
**重要提示**:.env或local_settings.py` 用于存放数据库密码、API 密钥等敏感信息，绝不能提交到 Git 仓库。

4. 首次提交:
   现在，将项目的所有文件（除了被 .gitignore 忽略的）添加到 Git 暂存区并提交。
   bash
git add .
git commit -m "Initial commit of Django project"

4. 在 GitHub 上创建新仓库

1. 登录 GitHub。
2. 点击页面右上角的 + 号，选择 New repository。
3. Repository name: 输入你的项目名称，例如 my-django-project。
4. Description (Optional): 简要描述你的项目。
5. Public/Private: 根据需要选择公开或私有。
6. 不要勾选 “Add a README file”, “Add .gitignore”, 或 “Choose a license”，因为我们已经在本地完成了这些。
7. 点击 Create repository。

创建成功后，GitHub 会显示一些命令，用于将本地仓库关联到远程仓库。

5. 连接本地仓库到 GitHub 远程仓库

回到你的本地项目目录，执行 GitHub 提供的命令来连接远程仓库并推送代码。通常会是这样的：

bash
git remote add origin https://github.com/your-username/my-django-project.git
git branch -M main
git push -u origin main

• git remote add origin <URL>: 将本地仓库与远程 GitHub 仓库关联，并将其命名为 origin (这是约定俗成的远程仓库名称)。
• git branch -M main: 将当前分支重命名为 main（GitHub 默认主分支名称）。
• git push -u origin main: 将本地 main 分支的代码推送到名为 origin 的远程仓库的 main 分支。-u 参数（或 --set-upstream）会设置 origin/main 为当前分支的 upstream，这样以后只需 git push 和 git pull 即可。

现在，你的 Django 项目代码已经成功上传到 GitHub。

6. 基本 Git 工作流程

日常开发中，你会频繁使用以下 Git 命令：

1. 查看状态: 检查工作区和暂存区的状态。
   bash
git status

2. 添加文件到暂存区: 将修改或新增的文件标记为待提交。
   bash
git add . # 添加所有修改过的文件
git add myapp/views.py # 添加特定文件

3. 提交更改: 将暂存区的文件提交到本地仓库，并附带一条有意义的提交信息。
   bash
git commit -m "Added user registration view"

4. 推送更改: 将本地提交推送到 GitHub 远程仓库。
   bash
git push

5. 拉取更改: 获取远程仓库的最新代码，并合并到本地分支。
   bash
git pull
   在开始工作前，养成 git pull 的习惯，以避免冲突。

7. 分支策略 (Feature Branches)

为了保持 main 分支的稳定性和代码质量，并支持并行开发，我们通常会采用“特性分支 (Feature Branch)”工作流。

1. 创建新分支: 从 main 分支创建一个新分支来开发一个新功能或修复一个 bug。
   bash
git checkout main # 切换到主分支
git pull # 确保主分支是最新状态
git checkout -b feature/user-profile # 创建并切换到新分支
   分支命名约定：feature/、bugfix/、hotfix/ 等，后跟具体功能描述。

2. 在新分支上开发: 在 feature/user-profile 分支上进行编码、测试和提交。
   bash
# ... 进行代码修改 ...
git add .
git commit -m "Implemented user profile view and template"
git push -u origin feature/user-profile # 首次推送新分支，-u 设置 upstream
   后续在该分支的推送只需 git push。

3. 合并分支: 当特性开发完成并通过测试后，将其合并回 main 分支。

   • 方法一：本地合并 (推荐通过 Pull Request)
     bash
git checkout main # 切换回主分支
git pull # 确保主分支是最新状态
git merge feature/user-profile # 合并特性分支到主分支
git push # 推送合并后的主分支到 GitHub
git branch -d feature/user-profile # 删除本地特性分支
   • 方法二：通过 GitHub Pull Request (推荐) – 见下一节。

8. 协作工作流 (Pull Requests)

Pull Request (PR) 是 GitHub 协作的核心。它允许你向其他分支（通常是 main）提出代码合并请求，并在此过程中进行代码审查。

1. 推送特性分支到 GitHub: 确保你的特性分支已经推送到 GitHub。
   bash
git push origin feature/user-profile

2. 创建 Pull Request:

   • 访问你的 GitHub 仓库页面。
   • GitHub 会自动检测到你最近推送的分支，并显示 “Compare & pull request” 按钮。点击它。
   • 或者导航到 “Pull requests” 选项卡，点击 “New pull request”。
   • 选择你的特性分支作为 compare（源分支），main 分支作为 base（目标分支）。
   • 填写 PR 标题和详细描述，说明本次修改的目的、内容和解决了什么问题。
   • 点击 “Create pull request”。

3. 代码审查 (Code Review):

   • 团队成员可以在 PR 页面查看代码变更、提出评论和建议。
   • 如果需要修改，你可以在本地特性分支上继续提交，然后 git push，PR 会自动更新。

4. 合并 Pull Request:

   • 当代码审查通过，并且所有检查（如 CI/CD 状态检查）都成功后，PR 就可以合并了。
   • 通常由项目维护者或团队负责人点击 “Merge pull request” 按钮。
   • GitHub 提供了几种合并方式：Create a merge commit (保留所有提交历史)、Squash and merge (将所有提交压缩成一个)、Rebase and merge (重新设置基点)。根据团队约定选择。

5. 删除远程分支: 合并后，可以选择删除 GitHub 上的特性分支。

9. 管理发布版本 (Tags)

当你的 Django 应用达到一个稳定的版本（例如 1.0、2.1.0）并准备发布时，可以使用 Git Tag 来标记这个特定的提交。

1. 创建标签: 切换到 main 分支，并确保是最新的。
   bash
git checkout main
git pull
git tag -a v1.0.0 -m "Release version 1.0.0"
-a 创建带注解的标签，-m 是标签信息。

2. 推送标签到 GitHub: 标签不会随着 git push 自动推送，需要单独推送。
   bash
git push origin --tags
   现在，你可以在 GitHub 仓库的 “Releases” 页面看到这个标签，并可以为其添加发布说明和二进制文件。

10. 管理敏感配置 .env 文件

前面提到 .env 文件（或类似的配置文件）不应被提交到 Git。在 Django 项目中，通常会结合 python-decouple 或 django-environ 等库来管理环境变量。

1. 安装库:
   bash
pip install python-decouple # 或 django-environ

2. 使用示例 (python-decouple):
   在 settings.py 中：
   “`python
   from decouple import config

   SECRET_KEY = config(‘SECRET_KEY’)
   DEBUG = config(‘DEBUG’, default=False, cast=bool)
   ALLOWED_HOSTS = config(‘ALLOWED_HOSTS’, cast=lambda v: [s.strip() for s in v.split(‘,’)])

   DATABASES = {
   ‘default’: {
   ‘ENGINE’: ‘django.db.backends.postgresql_psycopg2’, # Example for PostgreSQL
   ‘NAME’: config(‘DB_NAME’),
   ‘USER’: config(‘DB_USER’),
   ‘PASSWORD’: config(‘DB_PASSWORD’),
   ‘HOST’: config(‘DB_HOST’, default=’localhost’),
   ‘PORT’: config(‘DB_PORT’, default=’5432′),
   }
   }
   “`

3. 创建 .env 文件 (示例): 在项目根目录创建 .env 文件（确保已在 .gitignore 中）。
   SECRET_KEY=your_super_secret_key_here
DEBUG=True
ALLOWED_HOSTS=localhost,127.0.0.1
DB_NAME=myprojectdb
DB_USER=myuser
DB_PASSWORD=mypassword
DB_HOST=localhost
DB_PORT=5432
   注意: 在生产环境中，这些变量通常通过服务器的环境变量设置，而不是 .env 文件。

11. 总结

通过 Git 和 GitHub 管理 Django 项目版本，你将获得：

• 完整的代码历史: 每一个变更都可追溯。
• 高效的团队协作: 通过分支和 Pull Request 实现并行开发和代码审查。
• 代码质量保障: 结合 CI/CD 工具（如 GitHub Actions）可以自动化测试和部署。
• 安全管理敏感信息: 通过 .gitignore 和环境变量工具，防止敏感数据泄露。

遵循这些实践，你的 Django 项目开发将更加规范、高效和安全。祝你在 Django 之旅中编码愉快！

---