跳转至

使用git开发LHCb软件

学习目标

  • 学习如何将特定的LHCb包克隆到本地开发目录
  • 学习如何进行修改并上传以供他人审核

前置要求

开始之前，你应该应该应该对git的基本使用有一定了解，类似于入门套件中所教授的内容。

在本课程中，我们将向你展示使用git版本控制系统开发LHCb软件的完整工作流程。在LHCb，我们使用GitLab来管理 git 仓库。除其他功能外，GitLab允许你浏览每个项目的源代码，并通过便捷的网页界面审核新的更改（称为合并请求）。你可以在https://gitlab.cern.ch到CERN的GitLab实例。

原则上，与LHCb软件仓库交互有多种方式：

  1. 仅使用标准git命令的常规git工作流程。这要求你每次克隆并编译整个LHCb项目。当你的开发预计持续多天或更长时间，或者你与他人协作时，推荐使用这种方法。

  2. 使用一组lb-* 子命令的LHCb特定工作流程。这允许你在项目中检出单个包，并简化了对少数包的修改流程。这种方法主要适用于快速且独立的更改（与之前使用的getpack命令更接近）。

在这里，我们将重点介绍第二种工作流程。

在通过在GitLab中创建项目开始之前，你应该确保本地git配置和GitLab上的设置已充分配置：

你的姓名和电子邮件地址应在本地git配置中设置。为确保这一点，请运行：

$ git config --global user.name "Your Name"
$ git config --global user.email "Your Name <your.name@cern.ch>"
并填入你的信息。

连接到https://gitlab.cern.ch，使用你的CERN凭据登录。

访问https://gitlab.cern.ch/profile/keys并添加SSH密钥。

运行这个LHCb特定的配置命令： 

git config --global lb-use.protocol ssh
这确保LHCb命令使用ssh协议而不是https。

在GitLab网页界面中，点击"New project"按钮创建一个新项目。给你的项目命名为"LHCbSK"。

我们现在将设置一个本地LHCb开发区域，该区域将连接到你刚刚创建的git仓库。为了创建新的开发环境，运行： 

$ lb-dev --list LHCb
查看哪些版本的LHCb项目可用。选择最新版本并运行： 
$ lb-dev --name LHCbSK LHCb/<version>
其中你需要插入你选择的版本。这将自动运行git init来创建一个新的git仓库，并包含一些初始文件（Makefile、CMakeLists.txt等）。为了将你的仓库与远程仓库连接，运行： 
cd LHCbSK
git remote add origin ssh://git@gitlab.cern.ch:7999/<username>/LHCbSK.git
其中你需要替换为你的用户名。运行： 
git push -u origin master
一次将master定义为默认情况下我们应该推送的远程分支。

将你的开发项目推送到GitLab

你不一定需要为本地开发项目在GitLab上创建远程git仓库，特别是如果它的生命周期很短的话。但是，如果你计划与他人协作，一个可以同步工作的远程仓库是必不可少的。如果将开发项目用于ganga的GaudiExec，推送到GitLab也是很好的做法。

为本教程的目的，我们已经设置了一个包含TheTestPackage包的SKTest项目。为了能够处理SKTest项目的部分内容，首先运行： 

git lb-use SKTest
这将定义一个远程SKTest并从GitLab获取git仓库。

然后你可以运行： 

git lb-checkout SKTest/master TheTestPackage
检出SKTest项目中属于TheTestPackage包的文件。这在后台执行git checkout并将文件提交到本地（合成）分支。你可以使用git log查看历史记录。

现在你可以运行： 

make
来构建项目，进行一些修改，再次运行make等。你也可以使用： 
make test
运行测试。当你对更改满意后，运行： 
git add <your-changed-files>
其中你必须指定所有你想要存储更改的文件，然后运行： 
git commit
将它们存储在一个新的提交中。这将打开一个文本编辑器，允许你输入提交消息。

经常提交

经常提交没有任何代价。每当你完成了可以被视为一个独立更改单元的修改时，都应该尝试创建一个新的提交。

现在将你的更改推送到你新创建的GitLab项目: 

git push
并检查它们是否出现在网站上。

当你想要将你的提交上传到SKTest项目进行审核时，运行： 

git lb-push SKTest <username>-new-feature
在主GitLab仓库上创建一个新的<username\>-new-feature分支，并将你的提交上传到该分支。这将计算你的本地开发仓库与远程项目仓库之间的差异，并为远程项目创建相应的提交。现在，你可以通过访问https://gitlab.cern.ch/LHCb-SVN-mirrors/SKTest/merge_requests/new创建一个合并请求，选择<username>-new-feature分支作为源，master作为目标。为你的合并请求添加一个标题，并在正文中解释你所做的工作。

合并冲突

处理整个项目

处理整个项目同样简单，但需要对环境多一点关注。最重要的是，要准备好项目仓库克隆和构建产物可能需要几GB的磁盘空间，并且编译可能需要很长时间。详细的分步指南可在https://twiki.cern.ch/twiki/bin/view/LHCb/Git4LHCb#Building_everything_locally_exam找到。一种更集成的方法可以自动处理环境，链接是https://gitlab.cern.ch/lhcb/upgrade-hackathon-setup，其变体允许你使用一些夜间构建来节省编译许多项目的时间，链接是https://gitlab.cern.ch/lhcb-HLT/trigger-dev。