【自用】git常用操作
Git常用操作
- 1. vscode连接上远程容器后，使用git进行开发的大致流程
- 2. PR中出现文件内容上传错误，此时还没有合入，如何修改这次PR？
-
- 情况一：上次推送的本地仓库以及分支都还在
- 情况二：本地仓库没有，需要重新拉取远程分支进行开发
- 3. 如何在本地开发代码进行版本管理（本地开发）
-
-
- 示例工作流程
-
- 常用指令
-
- 如何基于某个分支创建一个新分支
- git 配置如何设置
- 理解 `git clone`
- 理解 `git fetch`
1. vscode连接上远程容器后，使用git进行开发的大致流程
-
本地创建一个新的文件夹，方便将远程仓库拉取到本地，并与其他文件隔离
-
进入到这个目录下
-
克隆远程仓库:
git clone -
【可跳过】环境问题，如果容器镜像有改变，需要重新使用镜像启动一个新容器，然后安装 requirement.txt 中的依赖
docker run ... pip install -r requirements.txt -
基于当前分支（一般是main分支或者master分支）创建新的分支
git checkout -b -
进行代码修改编写
-
提交你的更改：
git add .
git commit -m "Add a descriptive message here" -
推送分支到远程仓库:【注意：如果这是你第一次推送这个分支，你需要设置一个上游分支，如果这个分支没有被合并到远程main分支，那你下次就不用设置上游分支，可以直接执行
git push/git pull；但是如果这次PR被合并了，就要重新执行下面命令，创建一个新的PR】
git push --set-upstream origin
这种方式相当于同时完成了1. 推送到远程分支； 2. 关联本地分支跟远程分支【注：这里会推送到远程仓库的同名分支中，如果远程仓库中没有，会自动创建一个同名分支（by the way, 你也可以不用关联到远程同名分支，不过建议同名，这样方便一下就知道本地分支对应远程仓库的哪个分支）】
2. PR中出现文件内容上传错误，此时还没有合入，如何修改这次PR？
情况一：上次推送的本地仓库以及分支都还在
- 切换到对应分支
git checkout <分支名> - 在本地编辑器中，比如vscode，打开需要修改的文件夹，进行必要的更正【包括修改文件内容，删除文件等操作】
- 完成修改后，你需要将这些修改提交到你的本地仓库
git add . - 提交这些更改
git commit -m "描述你的更改" - 将你的更改推送到远程仓库上对应的分支
git push origin <分支名>
一旦你推送了更改到远程仓库的分支，远程仓库上对应分支的PR会自动更新，包含你新提交的更改。这意味着，你不需要关闭当前PR并创建一个新的PR。
GitHub的Pull Request（PR）功能设计得非常灵活。当你向一个已经存在的PR的分支推送新的提交时，GitHub会自动将这些新的提交包含到对应的PR中。这意味着，你可以通过向同一个分支继续推送更改来不断更新PR，而无需关闭并重新创建一个新的PR。这个特性对于PR的迭代过程非常有用，它允许你根据代码审查的反馈进行更改，并使这些更改立即反映在相同的PR中。
这种方式便于维护PR的上下文和讨论历史，使得参与者能够看到PR从开放到合并过程中的完整变更历史。此外，它也减少了管理PR的复杂性，因为你不需要跟踪多个PR来解决同一组更改或问题。
要确保你的PR被有效更新，请遵循以下最佳实践：
- 保持PR的聚焦：确保每个PR只关注一个具体的问题或特性，这使得审查者更容易理解和审查你的更改。
- 频繁同步：定期将主分支（如
main或master）的最新更改同步到你的特性分支，特别是在准备合并你的PR之前。这有助于减少合并冲突的可能性。- 清晰的提交信息：为你的每个提交编写清晰、描述性强的提交信息。这有助于审查者和未来的维护者理解每个更改的目的。
- 响应反馈：当收到代码审查反馈时，尽可能在同一个PR中进行更改并推送，而不是创建一个新的PR。
这里说明一下，这种情况也适合处理：当你本地在进行开发时，忘记首先拉取最新的仓库代码，导致远程仓库合并失败（例如：落后一个提交）
1. 拉取远程最新提交：git pull origin <目标分支> # 例如：git pull origin main
2. 手动解决冲突：
3. 提交合并结果：
git add . # 添加所有已解决的文件
git commit -m "合并远程更新"
4. 推送合并后的分支到远程：
git push origin <你的分支> # 推送合并后的提交
情况二：本地仓库没有，需要重新拉取远程分支进行开发
-
克隆远程仓库
git clone http:... -
查看远程仓库中的所有分支，确认 bug_fix 分支是否存在：
git branch -r -
拉取远程 bug_fix 分支：
git checkout -b bug_fix origin/bug_fix这条命令会创建一个本地分支 bug_fix，并将其与远程的 bug_fix 分支关联起来。如果本地已经存在 bug_fix 分支，可以直接切换到该分支并拉取最新内容：git checkout bug_fix git pull origin bug_fix -
进行代码修改
在本地的 bug_fix 分支上进行你需要的修改。修改完成后，添加并提交更改：git add <modified_files> git commit -m "描述你的修改内容" git push origin bug_fix # 把本地 bug_fix 分支的最新修改推送到远程仓库的 bug_fix 分支
3. 如何在本地开发代码进行版本管理（本地开发）
在本地使用 Git 维护代码版本而不提交到远程仓库是一个常见的开发实践，特别是在个人项目或实验性开发中。以 下是一些基本的步骤和命令，帮助你在本地管理代码版本：
-
初始化本地仓库
如果你还没有初始化一个 Git 仓库，可以在项目目录中运行以下命令：git init -
创建一个
main分支（用来维护最新的代码），和一个dev分支（用来开发新代码）：git checkout -b dev -
切换到
dev分支：git checkout dev -
编写你的代码
-
添加文件到暂存区：
git add <文件名> -
提交更改：
git commit -m "提交信息"【尽量在完成一个小功能后就提交一次，记录好提交信息，做好备份】
查看提交历史：
git log
这将显示所有提交的详细信息，包括提交哈希、作者、日期和提交信息。
更多git log用法：
git log --oneline：以简洁的单行格式显示每个提交
git log --graph：显示提交历史的图形化表示，有助于理解分支和合并的关系
git log --since="2023-06-01" --until="2023-06-30"：过滤指定日期范围内的提交
git log --author="Your Name"：只显示指定作者的提交
git log --grep="修复错误"：根据提交信息中的内容过滤提交
在dev分支上进行开发过程中肯定会多次来回修改代码，比如当前修改代码有bug，不想要这次的修改了，那就需要回到上次提交的状态，这时候有两种策略：
-
方式一：执行
git reset或git revert。
git reset可以将当前分支的指针移动到指定的提交，同时重置暂存区和工作区；git reset --hard <提交哈希>警告：–hard 选项会丢弃当前分支中自该提交以来的所有更改，请谨慎使用。
git revert创建一个新的提交，用于撤销指定提交的更改。这是更安全的选择，因为它不会改变历史记录。git revert <提交哈希> -
方式二：创建新的分支进行开发
可以创建多个分支进行管理，比如当前开发的功能正常，后面需要进行新功能开发，此时可以在这个正常分支dev基础上创建一个新开发分支dev2进行开发
当前在dev分支，执行git checkout -b dev2，然后进行开发
- 当在
dev分支开发完成后，切换回main分支，将dev的内容合并到main分支：git checkout main - 将
dev分支合并到main分支：git merge dev - 解决冲突，如果存在合并冲突，需要手动解决冲突，然后重新提交
- 删除
dev分支，合并完成后，如果不需要这个分支，可以将其删除：git branch -d dev（推荐删除，因为此时main分支已经有这次开发的内容了）
如果后续继续开发，可以在main分支上创建一个新的dev分支，即首先切换到main分支，然后执行
git checkout -b dev
示例工作流程
-
初始化仓库：
git init -
添加并提交初始文件：
git add . git commit -m "初始提交" -
创建并切换到新分支：
git branch feature_branch git checkout feature_branch -
在新分支上开发功能：
# 编写代码后 git add . git commit -m "添加新功能" -
切换回主分支并合并：
git checkout master git merge feature_branch -
删除分支：
git branch -d feature_branch
通过以上步骤，你可以在本地有效地管理代码的版本，而无需使用远程仓库。
常用指令
如何基于某个分支创建一个新分支
执行步骤：
-
git checkout dev： 切换到 dev 分支 -
git checkout -b test-branch：创建并切换到新分支
疑问·：执行完这两步，就能保证test-branch分支就是从dev创建的吗？
解答：
第一步git checkout dev会将当前工作目录切换到 dev 分支。这确保了接下来创建的新分支会以 dev 分支为起点。
第二步git checkout -b test-branch会基于当前分支（即 dev 分支）创建一个新分支 test-branch，并自动切换到这个新分支
git 配置如何设置
配置安全目录主要是为了增强 Git 的安全性，以下是具体原因：
防止恶意操作
在某些情况下，如克隆了一个不熟悉的仓库或在不受信任的目录中进行操作，可能存在恶意脚本或配置文件。如果 Git 不加限制地在这些目录中执行操作，可能会执行恶意代码，对系统造成损害。通过将目录设置为安全目录，Git 会确保只在受信任的目录中执行操作，降低安全风险。
避免权限问题导致的意外
当工作目录不属于当前用户，或者在多人共享的系统、自动化环境等场景下，Git 可能会因权限问题而拒绝操作。配置安全目录可以让 Git 明确哪些目录是受信任的，从而避免因权限问题导致的意外操作失败，确保 Git 在这些环境下能够正常工作。
适应团队协作和自动化环境
在团队协作中，多个开发者可能共享同一个工作目录，或者在 CI/CD（持续集成 / 持续交付）等自动化环境中，工作目录可能由不同的用户或进程创建和管理。配置安全目录可以确保 Git 在这些复杂的协作和自动化场景中，只在预期的、安全的目录中进行操作，保证项目的顺利进行。
符合安全最佳实践
从安全角度来看，显式地指定安全目录是一种良好的实践。它有助于限制 Git 的操作范围，减少潜在的安全漏洞，使 Git 的使用更加符合安全标准和规范，特别是在企业级开发和生产环境中，对于保障代码的安全性和系统的稳定性具有重要意义。
【如果想详细了解可以参考：…】
git config --list ：列出所有 Git 配置项，包括用户信息（如用户名和邮箱）、远程仓库信息等。这些配置项可能来自不同的配置文件，包括系统配置文件、全局配置文件和当前仓库的本地配置文件
git config user.name：只显示当前配置的用户名
git config user.email：用于查看当前配置的邮箱地址
- 配置用户名和邮箱，用于标识提交者：
git config --global user.name "Your Name" git config --global user.email "[email protected]" - 添加单个安全目录 ：可以使用命令
git config --global --add safe.directory /path/to/your/repository将指定目录添加到全局的安全目录列表中
理解 git clone
当你运行 git clone 命令克隆远程仓库时，它会默认克隆远程仓库的 所有分支，但只会从远程仓库的默认分支（通常是 main 或 master）检出（checkout）内容到本地的工作目录。这意味着：
本地仓库中会包含远程仓库的所有分支，但这些分支会被存储为 远程分支（remote branches），名称格式为 origin/。
本地只会创建一个与远程默认分支对应的 本地分支，通常是 main 或 master，并且这个本地分支会自动与远程分支（如 origin/main）关联起来。
例如，如果你克隆了一个远程仓库，远程仓库有 main 和 bug_fix 两个分支，执行 git clone 后：
本地会有一个 main 分支，这是从 origin/main 检出的内容。
本地还会有一个 origin/bug_fix 的远程分支引用，但它不会自动创建一个本地的 bug_fix 分支。
理解 git fetch
git fetch 命令会从远程仓库获取所有分支的更新，但它不会自动合并这些更新到本地分支。它只是将远程仓库的分支更新拉取到本地仓库的远程分支引用中（如 origin/main、origin/bug_fix 等）
例如，如果你运行以下命令：git fetch origin
这会拉取远程仓库 origin 的所有分支的最新内容，并更新本地仓库中的远程分支引用（如 origin/main、origin/bug_fix 等）。但本地的分支（如 main 或 bug_fix）不会自动更新，除非你手动合并或拉取。
要将远程分支的内容更新到本地分支，可以使用以下命令：
git fetch origin
git merge origin/main # 合并远程 main 分支到当前分支
或者，使用 git pull 命令，它相当于 git fetch 加上 git merge：
git pull origin main # 拉取远程 main 分支并合并到当前分支
git branch -r ：查看远程分支
git log --oneline --decorate --graph：如果你想要验证 test-branch 是否确实是从 dev 分支创建的，可以通过查看分支的历史记录来确认
git log：查看提交历史 q：退出查看历史【在执行完 git log 后，输入 q 可退出】
git reset --hard HEAD~1：回退到上一个版本
git reset --hard：强制重置当前分支到指定的提交，丢弃所有未提交的更改。【例如：git reset --hard origin/dev】
git branch -vv：查看本地分支与远程分支的关联关系
【持续更新ing…】