【产出】 > 给一个工程项目(代码 + CAD 模型 + 电路文件)建好 Git 仓库,掌握日常提交、分支、撤销操作,并用 Git LFS 管理大体积二进制文件。
【版本】 > 命令适用于 Git 2.23 及以上版本(
git switch/git restore从这个版本开始提供)。执行git --version查看当前版本。
一、为什么工程项目也要用 Git
做硬件和机械的同学常见的版本管理方式是"文件名 + 日期":机翼_v3_最终版_改2.SLDPRT。问题在于:
- 不知道某一版改了什么、为什么改。
- 代码、模型、电路图版本对不上,复现不出某个能用的状态。
- 多人协作时互相覆盖文件。
Git 能记录每一次修改的内容、时间和说明,任何一个提交过的状态都能找回来。
二、首次配置
安装 Git 后先设置姓名和邮箱,它们会写进每一次提交记录:
git config --global user.name "你的名字"
git config --global user.email "you@example.com"
git config --global init.defaultBranch main
Windows 用户建议再加一条,避免换行符在 Windows 和 Linux 之间来回转换导致整个文件显示被修改:
git config --global core.autocrlf true
三、建仓库与 .gitignore
在项目根目录执行:
git init
然后在第一次提交之前新建 .gitignore 文件,列出不需要进版本库的文件。下面是一个工程项目常用的模板,按你用的软件删减:
# 编译产物
build/
*.o
*.elf
*.bin
*.hex
__pycache__/
node_modules/
# SolidWorks 临时文件和备份
~$*
*.SLDBAK
# KiCad 备份与本地设置
*-backups/
*.kicad_prl
fp-info-cache
_autosave-*
# 系统文件
.DS_Store
Thumbs.db
# 密钥和本地配置,绝不能提交
.env
*.key
【注意】 >
.gitignore只对还没被跟踪的文件生效。已经提交进去的文件,再写进.gitignore也不会消失,需要先执行git rm --cached 文件名把它从版本库中移除(本地文件保留)。
四、日常三步:查看、暂存、提交
git status # 看哪些文件改了
git diff # 看具体改了哪些内容(文本文件)
git add 文件名 # 把要提交的修改加入暂存区
git add . # 或者暂存当前目录下全部修改
git commit -m "机翼加厚翼梁到 3mm,解决测试中弯折问题"
git log --oneline # 查看提交历史
提交说明写改了什么、为什么改,以后回头找版本时全靠它。"更新"、"修改"这种说明等于没写。
五、分支:试新方案不影响主线
想试一个新方案(比如换一种机身结构),不要直接在主线上改,开一个分支:
git switch -c try-carbon-tube # 新建并切换到分支
# ……修改、提交……
git switch main # 回到主线,文件会自动恢复成主线的状态
git merge try-carbon-tube # 方案可行,合并回主线
git branch -d try-carbon-tube # 合并后删除分支
方案不可行,直接切回 main 删掉分支即可,主线一点不受影响。
手上改到一半、又要临时切到别的分支时,用 stash 先把修改收起来:
git stash # 暂存当前未提交的修改
git switch main # 去处理别的事
git switch - # 回到原来的分支
git stash pop # 取回刚才的修改
六、撤销操作速查
按"修改到了哪一步"选择对应的命令:
| 情况 | 命令 | 风险 |
|---|---|---|
文件改乱了,还没 add,想恢复成上次提交的样子 | git restore 文件名 | 未提交的修改会永久丢失 |
已经 add,想撤出暂存区(文件内容保留) | git restore --staged 文件名 | 安全 |
| 刚提交完,发现说明写错或漏了文件(还没推送) | git add 漏掉的文件 后 git commit --amend | 会改写最后一个提交 |
| 某个提交已经推送,想撤销它的效果 | git revert 提交号 | 安全,生成一个新的反向提交 |
| 找回某个文件的旧版本 | git restore --source=提交号 文件名 | 覆盖当前文件 |
【注意】 > 已经推送到远程、别人可能拉取过的提交,不要用
commit --amend或git reset改写后强制推送,这会让协作者的历史和你不一致。撤销已推送的提交用git revert。git reset --hard会直接丢弃工作区修改,使用前务必确认。
Pro Git 书中的原则是:只要提交过,几乎都能找回来;没提交的修改丢了,基本就找不回来了。 所以养成小步、频繁提交的习惯。
七、CAD 模型等大文件:用 Git LFS
Git 会保存每个文件的每一个版本。文本文件只记录差异,但 .SLDPRT、.STEP、.blend 这类二进制文件每改一次就完整存一份,仓库很快膨胀到几个 GB,克隆和推送都非常慢。
Git LFS(Large File Storage)把大文件存到单独的存储里,仓库中只保留一个很小的指针文件。
1. 安装并初始化(每台电脑执行一次)
Git for Windows 已自带 LFS;macOS 用 brew install git-lfs;Ubuntu 用 sudo apt install git-lfs。然后执行:
git lfs install
2. 指定哪些文件交给 LFS(每个仓库执行一次)
git lfs track "*.SLDPRT" "*.SLDASM" "*.SLDDRW"
git lfs track "*.step" "*.stp" "*.stl" "*.3mf"
git lfs track "*.blend" "*.psd"
git add .gitattributes
git commit -m "配置 Git LFS 跟踪 CAD 与模型文件"
规则保存在 .gitattributes 文件中,这个文件必须提交,团队其他人拉取后才会按同样规则处理。
3. 之后照常使用 git add / git commit / git push,LFS 会自动处理。
【注意】 >
git lfs track只对之后新加入的文件生效。已经以普通方式提交过的大文件,需要用git lfs migrate改写历史才能转进 LFS,这会改变提交号,团队协作的仓库要提前通知所有人。最省事的做法是建仓库时第一步就配好 LFS。另外,GitHub、GitLab、Gitee 对 LFS 存储容量和流量都有额度,大型装配体项目要提前确认。
【提示】 > 二进制文件无法合并。两个人同时改同一个零件,只能保留其中一份。团队协作时提前约定好谁负责哪个零件,或者使用
git lfs lock文件锁(需要服务器支持)。
八、推送到远程仓库
在 GitHub、GitLab 或 Gitee 上新建一个空仓库,然后:
git remote add origin 仓库地址
git push -u origin main
以后每次只需 git push。在另一台电脑上用 git clone 仓库地址 拉取完整项目。
参考资料
- Pro Git 中文版(官方免费电子书):https://git-scm.com/book/zh/v2
- Pro Git:撤消操作:https://git-scm.com/book/zh/v2/Git-基础-撤消操作
- Git LFS 官网:https://git-lfs.com/
- GitHub 官方 .gitignore 模板集合:https://github.com/github/gitignore
评价 (0)