本文幫助您快速了解和使用云效代碼管理。
前提條件
背景信息
云效代碼托管 Codeup 可通過以下入口訪問:
步驟一:新建第一個代碼庫
登錄云效代碼管理Codeup,單擊首頁右上角新建代碼庫按鈕。
在新建對話框中完成以下信息的填寫:
設置代碼庫名稱:代碼庫的名稱,用于代碼庫命名,支持輸入字母和數字、 '_'、 '.'和'-',且只能以字母、數字或'_'開頭。
設置代碼庫路徑。
設置公開性:設置代碼庫可見性,企業公開庫對企業內成員(不包含外部成員)可見,私有倉庫僅限代碼庫成員可見,參見平臺權限設置。
設置代碼庫描述:代碼庫的簡單介紹。
設置 readme、.gitignore 、存儲加密等高級初始化選項。
單擊確定,成功創建您的第一個代碼庫。
說明如已經使用其他代碼托管平臺,云效提供代碼快速導入能力,參見遷移/導入三方代碼庫。
步驟二:提交第一行代碼
云效代碼管理支持兩種方式進行代碼提交:在網頁端修改和提交,以及在本地 Git 客戶端代碼提交。
網頁端代碼提交
在網頁端進入已創建的代碼庫。
選擇某個文件,以 README.md 為例,單擊右上角的編輯按鈕。
修改部分內容,例如在 README.md 文末增加如下內容,修改后點擊保存。
//說明readme文檔作用 >readme 文檔用來承載代碼庫的說明
在彈窗中撰寫提交說明。
填寫提交說明的標題和詳細描述,描述這次修改的原因。如不填寫,會使用默認的提交說明。
說明在提交說明的標題中,盡量使用英文,長度以不超過50個字節為宜,且末尾無需添加句點。
單擊立即提交,將文件修改提交到相應的分支(如 master 分支)。
驗證結果:單擊庫菜單的提交列表,查看確認剛才的修改已提交到代碼庫。
本地 Git 客戶端代碼提交
本地使用 Git 需先進行安裝,參見安裝Git。
克隆代碼至本地
在網頁端進入已創建的代碼庫。
單擊庫首頁右上角克隆/下載按鈕,獲取克隆地址。
可以選擇 SSH 或者 HTTP 的方式進行克隆,分別對應不同的克隆地址。
克隆代碼庫。
通過 HTTPS 協議克隆。
說明首次克隆前請先配置克隆賬號和密碼,參見配置 HTTPS 克隆賬號密碼。
在源文件的代碼庫地址欄,選擇“HTTPS”,復制地址。
在 Git Bash 中輸入克隆命令。
git clone https://codeup.aliyun.com/your-company/xxx.git # 換成你復制的代碼庫地址
按照終端提示輸入已設置的克隆賬號與密碼。
通過 SSH 協議克隆。
說明首次克隆前請先配置 SSH 公鑰,參見配置 SSH 密鑰。
在源文件的代碼庫地址欄,選擇“SSH”,復制地址。
在 Git Bash 中輸入克隆命令。
git clone gi*@codeup.aliyun.com:your-company/xxx.git # 換成你復制的代碼庫地址
終端會自動查找可用的公鑰、私鑰文件,完成和遠程服務器的 SSH 連接,完成倉庫克隆。
本地代碼修改和推送
將本地文件的改動(修改、添加、刪除等),添加到 Git 索引。例如在本地的代碼庫新建名為“hello.java”的文件,輸入
git add
命令告訴 Git 開始追蹤這個文件的版本變化。git add hello.java
創建新提交。
輸入
git commit
命令將索引中記錄的修改提交到代碼倉庫里。git commit -m "add hello.java" # 雙引號里寫提交說明
將本地代碼倉庫的改動推送至遠端的代碼倉庫。
以推送到遠端 master 分支為例,輸入命令:
git push
驗證結果。
訪問目標代碼庫,刷新瀏覽器,可以看到推送記錄以及與本地相同的修改內容,即新增了hello.java 文件。
步驟三:邀請成員協作
代碼庫管理者邀請成員。
進入目標代碼庫,選中左側導航欄中的成員,查看代碼庫成員信息。
代碼庫管理者添加成員。
支持通過用戶名搜索屬于當前企業的所有成員,已加入當前代碼庫的成員默認被選中。
若用戶未加入企業,需先邀請成為企業成員后再添加至代碼庫成員,參見企業成員管理。
選擇成員,添加成員的角色。
支持按部門添加成員,同時開啟自動同步人員變更,在部門增刪人員時無需在代碼庫手動修改人員權限。
步驟四:啟用代碼檢測
開發過程中,為了更好的管理您的代碼資產,Codeup 內置了代碼檢測服務,單擊新建檢測任務,在彈窗新建檢測任務下選擇檢測方案,具體請參見使用代碼檢測服務,觸發方式選擇提交觸發和合并請求觸發均可,設置后將通過自動觸發掃描,并及時提供結果反饋。
步驟五:使用代碼評審
Codeup 支持多人協作的代碼評審服務,功能開發完畢后,您可以發起合并請求,通過審批流程相關負責人評審您的代碼,持續關注編碼質量。