Github的一個奇技淫巧,你學(xué)會了嗎?
背景
前段時間給 VictoriaLogs 提交了一個 PR:https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4934
本來一切都很順利,只等合并了,但在臨門一腳的時候社區(qū)維護人員問我可否給 git commit 加上簽名。
于是我就默默的調(diào)試到了凌晨四點??
圖片
以前我也沒怎么注意過這個選項,經(jīng)過 Google 后發(fā)現(xiàn) Idea 在提交的時候可以自行設(shè)置。
圖片
當我勾選了這個提交新的代碼后,依然被告知沒有正確的簽名,這時我才發(fā)現(xiàn)理解錯誤了。
為 GitHub 的提交簽名
結(jié)合這位社區(qū)大佬給的文檔,他所需要的是每次提交的代碼都是有簽名的,類似于這樣:
圖片
如果我們想要 GitHub 現(xiàn)實 Verified 這個標簽,那就需要對 commit 或者是打的 tag 進行簽名。
而簽名的方式有三種:GPG, SSH, S/MIME,這里我以 GPG 簽名為例,整體流程如下:
圖片
先在https://www.gnupg.org/download/這里下載安裝 GPG 的命令行程序。
gpg --full-generate-key
使用這個命令生成 key,之后會根據(jù)提示錄入一些信息,包含你的 ID 和郵箱,建議都和 GitHub 的 ID 郵箱保持一致即可,然后一路回車完事。
之后可以使用這個命令查看剛才創(chuàng)建的 Key:
gpg --list-secret-keys --keyid-format=long
------------------------------------
sec 4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10]
uid Hubot <hubot@example.com>
ssb 4096R/4BB6D45482678BE3 2016-03-10
我們需要將 3AA5C34371567BD2 這個 Key 的 ID 字符串復(fù)制,之后執(zhí)行:
gpg --armor --export 3AA5C34371567BD2
# Prints the GPG key ID, in ASCII armor format
此時會打印出公鑰,我們將
-----BEGIN PGP PUBLIC KEY BLOCK-----
-----END PGP PUBLIC KEY BLOCK-----
這些數(shù)據(jù)復(fù)制到 GitHub 的個人設(shè)置頁面:
圖片
此時還沒完,如果我們直接提交代碼的也不會有 Verified 的標簽。
圖片
我們還需要打開 git 的 config 設(shè)置:
git config commit.gpgsign true
# 全局打開
git config --global commit.gpgsign true
git commit -S -m "YOUR_COMMIT_MESSAGE"
git push
這樣提交的 Commit 就會打上驗證的標簽了。
圖片
-S 的效果和在 idea 中選中 Sign-off 的效果一樣。
官方文檔也有詳細的步驟:https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification
Squash 合并提交
不過在我這個 PR 的背景下還有一個步驟沒有完成,就是我之前提交的 Commit 都沒要驗證,我需要將他們都合并為一個驗證的 Commit 然后在強制推送上去,這樣整個 git log 看起來才足夠簡潔。
最終效果如下,只有一個 Commit 存在。
圖片
這時候就得需要 git rebase 出馬了。
圖片
以剛才測試的這兩個提交為例,我需要將他們合并為一個提交。
我們先使用這個命令:
git rebase -i HEAD~N
git rebase -i HEAD~2
N 就是我們需要合并幾個提交,在我這里就是 2.
圖片
我們需要將除了第一個 commit 之外的都修改為 s,也就是下面注釋里的 squash 的簡寫(壓縮的意思)。
這是一個 vim 的交互編輯模式,編輯完成之后保存退出。
不會還有程序員不知道如何保存 vim 退出吧??。
保存后又會彈出一個編輯頁面,讓我們填寫這次壓縮之后的提交記錄,默認會幫我生成好,當然你也可以全部刪掉后重寫。
圖片
我這里就直接使用它生成好的就可以了,依然還是保存退出。
最后再強行推送到我所在的分支即可:
git push origin test-rebase -f
在這個分支的提交頁面也只會看到剛才強行推送的記錄了,剛才的兩個提交已經(jīng)合并為這一個了。
圖片
總結(jié)
借著這個機會也了解了 rebase 的騷操作挺多的,不過我平時用的最多的還是 merge,這個倒沒有好壞之分,只要同組的開發(fā)者都達成一致即可。