git：gitlab使用完全总结

最新推荐文章于 2025-02-26 09:56:31 发布

OceanStar的学习笔记

最新推荐文章于 2025-02-26 09:56:31 发布

阅读量4k

点赞数 2

分类专栏：工具软件

本文链接：https://blog.csdn.net/zhizhengguan/article/details/113122272

版权

工具软件专栏收录该内容

193 篇文章

订阅专栏

文章目录

安装
用户
Projects
Repositories
issue（问题跟踪器）
发布
GitLab CI/CD
- GitLab CI/CD 介绍
clion与gitlab

GitLab是一个基于Git的平台，提供对Git存储库的远程访问，并通过创建用于管理代码的私有和公共存储库，有助于软件开发周期。

安装

用户

前提：请先注册一个账户

查看用户资料

在这里插入图片描述

进入用户设置

在这里插入图片描述

效果：
在这里插入图片描述

修改密码

在这里插入图片描述

更改用户名

username是namespace 与您的用户ID相关的唯一身份。对其进行更改可能会产生意想不到的副作用。因此不建议进行修改

查看用户登录日志

在这里插入图片描述

创建Access Token（个人访问令牌）

如果您无法使用OAuth2，则可以使用个人访问令牌通过GitLab API进行身份验证。
您可以在GitLab个人资料中创建任意数量的个人访问令牌。

登录到GitLab。
在右上角，选择您的头像。
选择Settings
在左侧边栏中，选择Access Tokens

在这里插入图片描述

选择令牌的名称和可选的到期日期
选择所需的范围。
选择Create personal access token.
将个人访问令牌保存在安全的地方。如果导航或刷新页面，但没有保存令牌，则必须创建一个新令牌

您可以随时单击“活动个人访问令牌”区域下的相应“撤消”按钮来撤消任何个人访问令牌

设置为中文

在这里插入图片描述

Projects

在GitLab中，您可以创建项目来托管您的代码库。您还可以使用项目来跟踪问题，计划工作，在代码上进行协作以及不断地构建，测试和使用内置的CI / CD来部署您的应用程序。

项目可以公开，内部或私人使用（具体参见项目可见度说明）。GitLab不会限制您可以创建的私人项目的数量

新建项目

在这里插入图片描述

新建空白项目

选择“新建空白项目”
填写必要的信息
- 项目的可见度，具体请参见目录项目可见度
- 项目名称建议做到见名知义，不建议使用中文
效果：

同时，如果你没有配置ssh，那么可能就会如下提示，解决方法参见目录配置ssh key，在你配置之前是不可能将项目拉取到本地或者将本地项目推送到远程仓库的

在这里插入图片描述

项目模板

我一般都是创建空白项目，这个没用过

项目模板有两种主要类型：

内置模板，来自以下组：
- project-templates
- pages
自定义项目模板，用于由GitLab管理员和用户配置的自定义模板。

内置模板

内置模板是项目模板，它们是：

在project-templates 和pages组中开发和维护。
与GitLab一起发布。

要在“新建项目”页面上使用内置模板，请执行以下操作：
在这里插入图片描述

项目可见度

GitLab允许所有者将项目的可见性设置为public，internal或private。这些可见性级别会影响谁可以在公共访问目录（/public在您的GitLab实例下）中查看项目，例如https://gitlab.com/public

公开

可以克隆公共项目，而无需通过HTTPS进行任何身份验证。
它们在/public所有用户的公共访问目录（）中列出。
任何登录的用户都对存储库具有来宾权限

内部

内部项目可以克隆用户除了通过登录任何外部用户。
它们也列在公共访问目录（/public）中，但仅适用于登录用户。
除外部用户外，所有登录用户均具有存储库的来宾权限。

私人

私人项目只能由项目成员（来宾除外）克隆和查看。
它们仅出现在/public项目成员的公共访问目录（）中

如何更改项目可见性

在这里插入图片描述

配置ssh key

目的：安全访问；每次不需要使用用户名和密码就可以验证gitlab服务器了
准备：在生成ssh key之前，必须先安装git

配置一个ssh key

1、打开本地git bash,使用如下命令生成ssh公钥和私钥对

#设定git账号和邮箱
git config --global user.name "zhangsan"
git config --global user.email "2071347130@qq.com"
#生成ssh密钥，可选是否加邮箱，如果不加就去掉-C参数和邮箱(正常情况下一路回车)
ssh-keygen -t rsa -C "2071347130@qq.com"
#假如以前可能生成过密钥，所以她可能会提醒你是否要覆盖(y/n)?输入y并回车即可

2、然后打开~/.ssh/id_rsa.pub文件(~表示用户目录，比如我的windows就是C:\Users\oceanstar)，复制其中的内容
在这里插入图片描述

3、打开gitlab
在这里插入图片描述

id_rsa.pub 文件复制到密码框中，并给这个key起一个名字，以及选择到期时间
在这里插入图片描述

4、到此就完成了gitlab配置ssh key的所有步骤，我们就可以愉快的使用ssh协议进行代码的拉取以及提交等操作了

5、再试一下拉取代码和提交代码，应该就不需要输入密码了

本地配置多个ssh key[尚未验证]

大多数时候，我们的机器上会有很多的git host,比如公司gitlab、github、oschina等，那我们就需要在本地配置多个ssh key，使得不同的host能使用不同的ssh key ,做法如下（以公司gitlab和github为例）：

1、为公司生成一对秘钥ssh key

ssh-keygen -t rsa -C 'yourEmail@xx.com' -f ~/.ssh/gitlab-rsa

2、为github生成一对秘钥ssh key

ssh-keygen -t rsa -C 'yourEmail2@xx.com' -f ~/.ssh/github-rsa

3、在~/.ssh目录下新建名称为config的文件（无后缀名）。用于配置多个不同的host使用不同的ssh key，内容如下：

# gitlab
Host gitlab.com
    HostName gitlab.com
    PreferredAuthentications publickey
    IdentityFile ~/.ssh/gitlab_id-rsa
# github
Host github.com
    HostName github.com
    PreferredAuthentications publickey
    IdentityFile ~/.ssh/github_id-rsa
  
# 配置文件参数
# Host : Host可以看作是一个你要识别的模式，对识别的模式，进行配置对应的的主机名和ssh文件
# HostName : 要登录主机的主机名
# User : 登录名
# IdentityFile : 指明上面User对应的identityFile路径

4、按照上面的步骤分别往gitlab和github上添加生成的公钥gitlab_id-rsa.pub和github_id-rsa.pub
5、OK，大功告成，再次执行git命令验证是不是已经不需要再次验证权限了。

6、再次查看~/…ssh目录下的文件,会有gitlab_id-rsa、gitlab_id-rsa.pub和github_id-rsa、github_id-rsa.pub四个文件

ps：
1、以下命令能让Git以彩色显示git config --global color.ui auto
2、如果在Windows使用命令行 (Git Bash), 含非ASCII字符的文件名会显示为 “\346\226\260\350\246…”。若设定如下，就可以让含非ASCII字符的文件名正确显示了git config --global core.quotepath off
3、若在Windows使用命令行，您只能输入ASCII字符。所以，如果您的提交信息包含非ASCII字符，请不要使用-m选项，而要用外部编辑器输入。
外部编辑器必须能与字符编码UTF-8和换行码LF兼容。
git config --global core.editor "\"[使用编辑区的路径]\""

拉取项目到本地

前提

配置好了ssh key
已经在远程服务器中建立好了项目

有两种方法：

本地创建项目，然后推送到远程：适用于非空项目
远程仓库拉取到本地：适用于空项目

本地项目推送到远程

cd existing_folder
git init    # 将当前目录移动到本地的git数据库
git remote add origin git@xxxxxx:xiehaoyin/web_camera.git   # 将当前目录和远程仓库关联起来
git add .    # 将当前目录下的所有文件提交到索引
git commit -m "Initial commit"  # 提交本次修改到本地仓库
git push -u origin master       # 将本地仓库推送到远程仓库的master分支

git@xxxxxx:xiehaoyin/web_camera.git，就是之前新建空白项目提醒要记下来的东西。如果没有记下来也没有关系，解决方法见下图：
在这里插入图片描述

远程仓库拉取到本地

如果本地没有test工程，可以先克隆一份下来，然后新增或修改工程文件
在这里插入图片描述

git clone git@****/test.git
cd test
touch README.md
git add README.md
git commit -m "add README"
git push -u origin master

将项目拉取到本地之后，我们应该做些什么呢？

建议为每个项目创建一个README.md和忽略文件

提交README和忽略文件

新建一个名为「README.md」的文本文件，并添加必要的信息

git add README.md
git status
git commit -m "add README"

新建一个.gitignore文件，内容可以参考https://github.com/github/gitignore

git add .gitignore
git status
git commit -m "add .gitignore"

接下来，要进行开发的话，就一定要使用分支功能

查看项目的事件

在这里插入图片描述

查看项目的提交语言

对于每个存储库的默认分支，GitLab将确定使用了哪种编程语言，并将其显示在项目页面上。
如果缺少此信息，将在更新项目的默认分支后添加。此过程最多可能需要5分钟。
并非所有文件都被检测到；文档，供应商代码和大多数标记语言均排除在外。
可以通过覆盖默认值来调整此行为。例如，.proto要检测文件.gitattributes，请在存储库的根目录中添加以下内容

为项目加⭐

在这里插入图片描述

查看加⭐的项目

在这里插入图片描述

删除项目

1、进入项目 --> settings --> general --> Advanced Collapse
在这里插入图片描述

2、往下面找，点击 “Remove project”

在这里插入图片描述

fork项目（失败，不要看）

在项目主页的右上角，单击“分叉”按钮。

出现错误：（– Name has already been taken）
在这里插入图片描述
解决：？？？？？？？？

获取项目ID

每个gitlab中的项目都有一个唯一识别号，我们称之为project id，project id可以在项目的首页看到
在这里插入图片描述

添加、删除成员到项目中（没有这个权限）

Repositories

一般需要先创建项目（请参考目录 Projects/新建项目），才可以使用这个面板中的功能。

在这里插入图片描述

Files

在这里插入图片描述

创建文件

当需要创建文本文件时，可以在本地创建，也可以直接在网页端创建

进入一个项目
选择新文件

在这里插入图片描述

在这里插入图片描述
效果：

在这里插入图片描述
我们点进去这个文件

查找文件

在这里插入图片描述

查看文件修改记录

相当于 git blame- 显示文件的每一行最后修改的版本和作者

在这里插入图片描述

效果：
在这里插入图片描述

// -L 11,12 含义是该文件的第11行和12行的修改记录
-  git blame -L 11,12 aaa/file.txt

文件历史

提交的文件历史记录
相当于git log README.md

效果：

在这里插入图片描述

上传文件

当内容为文本时，创建文件的能力非常出色。但是，这不适用于二进制数据，例如图像，PDF或其他二进制文件类型。在这种情况下，您需要上传文件。

在这里插入图片描述

效果：

创建目录

在这里插入图片描述
在新目录对话框中，输入目录名称，提交消息，然后选择目标分支。单击创建目录以完成。

效果：
在这里插入图片描述

commit

在这里插入图片描述

Branches

可以为每个功能创建一个分支，这样分支之间就是彼此独立的，不会相互影响
我们不应该在主分支中开发，而是应该新建分支开发，具体可以参考分支管理策略

创建新分支

使用gitlab web在远程仓库中创建分支

创建分支之后记得同步到本地

方法1：从分支面板创建分支

在这里插入图片描述

方法2：

在这里插入图片描述

从issue中创建

准备：请先学习怎么创建issue
进入issue详情
创建新分支

在这里插入图片描述

效果如下

本地创建分支之后推送到远程

创建develop

git checkout master  # develop 是基于master
git pull     # 每次创建分支之前都要pull同步仓库
git checkout -b develop master  # 创建分支

然后git push到远程仓库

git push -u origin master

创建功能分支

git checkout -b feature-user_module  develop

然后推送到远程

git push

git pull可能遇到的情况：

There is no tracking information for the current branch.
Please specify which branch you want to merge with.
See git-pull(1) for details.

    git pull <remote> <branch>

If you wish to set tracking information for this branch you can do so with:

    git branch --set-upstream-to=origin/<branch> develop

错误原因：使用git在本地新建一个分支后，需要做远程分支关联。如果没有关联，git会在下面的操作中提示你显示的添加关联。
解决方法：
1、查看远程分支

$ git remote
origin

因此在gitlab上创建远程分支

2、使用命令git branch --set-upstream ;实例如下，其中debug为创建的分支

git branch --set-upstream debug origin/debug

命令的最终修改都是针对 config 文件。

使用--set-upstream 去跟踪远程分支。

比较两个分支

在这里插入图片描述

修改默认分支

创建新项目时，GitLab设置master为存储库的默认分支
我们也可以修改其他分支为默认分支（一般不会改，也不建议改）

在这里插入图片描述

配置受保护的分支

配置受保护的分支，是为了防止意外删除和强制推送
master默认情况下，分支受保护
如果你还想保护某个分支，可以这样配置

请求合并分支

1、准备：先创建一个分支
2、开始准备请求合并分支
在这里插入图片描述
3、选择源分支和目标分支，然后单击Compare branches and continue 按钮

您将看到标题，说明和其他字段，如分配用户，设置里程碑，标签，源分支名称和目标分支名称，然后单击提交合并请求按钮:

approve：允许合并
merge：合并分支

Contributors：查看项目贡献者

在这里插入图片描述

Graph：项目可视化提交日志

graph以可视方式显示存储网络的历史纪录，包括分支和合并。
在这里插入图片描述

推送规则（没有这个功能）

因为我没有这个权限配置，所以这个就不学了

project’s Settings > Repository > expand Push rules

将当前项目推送到镜像（失败）

这个没有用过

在这里插入图片描述

issue（问题跟踪器）

问题是GitLab中协作进行想法，解决问题和计划工作的基本机制。

使用问题，您可以在您和您的团队以及外部合作者之间共享和讨论建议（在实施之前和实施期间）。

您可以将问题用于多种目的，并根据需要和工作流程进行定制。常见的用例包括：

讨论新想法的实施。
跟踪任务和工作状态。
接受功能建议，问题，支持请求或错误报告。
详细说明新的代码实现。

在这里插入图片描述

Labels

随着您在GitLab中问题，合并请求和史诗数量的增长，跟踪这些项目变得越来越困难。尤其是随着您的组织从几个人成长到成百上千。标签就是在这里出现的。它们可以帮助您组织和标记工作，以便您可以跟踪和找到您感兴趣的工作项。
在这里插入图片描述

生成默认标签集

如果项目或组没有标签，则可以从标签列表页面生成一组默认的项目或组标签。如果列表为空，页面将显示“生成默认标签集”按钮。
在这里插入图片描述
点击后

创建自定义标签

带作用域标签的工作流

跟踪功能所针对的操作系统平台，每个问题只应针对一个平台

platform::iOS
platform::Android
platform::Linux

效果：

标签优先级

在标签上加上星号
在这里插入图片描述

项目标签和组标签

GitLab中有两种类型的标签：

Project labels
- 只能分配给该项目，并且只能合并该项目中的请求
Group labels
- 分配给选定组或其子组中的任何项目中的问题并合并请求

管理issue

创建issue

方法1： Project’s Dashboard > Issues > New Issue:

Projects 、选择一个项目

在这里插入图片描述

项目的左侧边栏，选择Issues，这时出现如下界面
- New issue：创建一个新issues。
- import issues：导入issues
我们点击New issue，出现如下界面，可以添加如下内容
- 标题
- 类型
- 描述：提出的issue的具体内容
- 机密问题：只有一定权限的人才能看到这个问题
- Assignee：你要向谁提问
- Due date：请Assignee在问题到期之前处理
- Milestone：没有用过
- Labels：用处是给issues分组
效果是：
当然，我们可以点击close issue 直接关闭这个issue
效果如下：（可以看到，关闭了没有关系，可以重新打开这个issue）

我们来尝试解决这个问题

如果点击commit，不会关闭这个issue（关闭了也没有关系，可以重新打开这个issue）
如果点击commit & close issue，会close issue（当您确定某个问题已解决或不再需要时，直接关闭issues）

在这里插入图片描述

可以看到还有一种方法创建问题

在这里插入图片描述

可以创建一个保密issue “此问题属于机密信息。。。。。”，那么只有一定的人才能看到这个信息
我们也可以在issue问题之后修改issue的保密性

在这里插入图片描述

搜索issue、对issue进行排序
删除问题

将issue导出到CSV

CSV是一种将数据从一个程序获取到另一个程序的便捷方法，其中一个程序无法读取其他程序的正常输出
CSV文件可与任何基于绘图仪或电子表格的程序一起使用，例如Microsoft Excel，Open Office Calc或Google Spreadsheets。

使用场景

制作问题快照以进行离线分析或与可能不在GitLab中的其他团队进行交流
根据CSV数据创建图表，图形和图表
出于审计或共享的原因，以任何其他格式显示数据
将问题导入其他地方到GitLab之外的系统长期问题数据分析，同时创建多个快照
使用长期数据收集问题中给出的相关反馈，并根据实际指标改进产品

操作

选择项目后，您可以在问题页面上使用搜索栏以及“全部/打开/关闭”选项卡来缩小要导出的问题。
返回的所有问题都将导出, 导出的问题始终按排序Issue ID
GitLab要求您确认问题的数量和用于导出的电子邮件地址，然后准备电子邮件。

Boards

Boards是一个软件项目管理工具，用于计划，组织和可视化功能或产品发布的工作流程

结合了问题跟踪和项目管理功能，将所有内容保持在一起，因此您无需在不同平台之间跳转即可组织工作流程。

在这里插入图片描述

创建issue

在这里插入图片描述

Service Desk

邮件通知，还没有用到过

在这里插入图片描述

Milestones

Milestones是一种跟踪问题并合并为在特定时期内实现更广泛目标二创建的请求的方法
Milestones使你可以组织问题并将请求合并到一个紧密联系的组中，并带有一个可选的开始日期和一个可选的截止日期
Milestones可用作敏捷冲刺，因此你可以跟踪所有问题并合并与特定冲刺有关的请求。为此：
- 设置里程碑的开始日期和截止日期，以代表敏捷冲刺的开始和结束。
- 将里程碑标题设置为敏捷冲刺的名称，例如November 2018 sprint。
- 通过将问题的右侧边栏关联到所需的里程碑，将问题添加到敏捷冲刺中
Milestones可以用作发布，为此：
- 设置里程碑到期日期以表示发布的发布日期，并将里程碑开始日期保留为空
- 将里程碑标题设置为发行版本，例如Version 9.4
- 通过关联问题右侧的期望里程碑，将问题添加到您的发行中

此外，您可以将里程碑与 Releases feature集成在一起。

项目里程碑和小组里程碑

在这里插入图片描述

创建项目里程碑

Issues > Milestones.
点击 New milestone
输入标题，可选描述，可选开始日期和可选截止日期
效果

在这里插入图片描述

里程碑视图显示标题和描述。
这些标签下面还包含显示以下内容的标签：
- 问题：显示分配给里程碑的所有问题。这些内容显示在名为：的三列中：
  - 未开始的问题（未解决和未分配）
  - 进行中的问题（未解决和已分配）
  - 已完成的问题（已关闭）
- 合并请求：显示分配给里程碑的所有合并请求。这些内容显示在名为：
  - 进行中的工作（未分配和未分配）
  - 等待合并（打开和未分配）
  - 拒绝（关闭）
  - 合并后
- 参与者：显示分配给该里程碑的所有问题的受让人。
- 标签：显示在分配给里程碑的事件中使用的所有标签

发布

查看发布

方法1：

在这里插入图片描述

方法2：

在这里插入图片描述

排序发布

在“发布”页面的右上角，您可以使用排序按钮按发布日期或创建日期排序发布。您可以按升序或降序对发布进行排序。

在这里插入图片描述

创建发布

有两种方法

UI界面发布
通过Releases API发布

UI界面发布

在这里插入图片描述

添加必要的信息

Tag name（标签名）：发行标签名称应包括发行版本，建议起名规则为(Major).(Minor).(Patch)。比如10.5.7
- 10代表主要版本。主要版本是10.0.0，但通常称为10.0
- 5代表次要版本。次要版本是10.5.0，但通常称为10.5
- 5代表次要版本。次要版本是10.5.0，但通常称为10.5
Create from：从哪个分支创建release
- 我们一般不会在master版本创建release，而是从develop中分出一个release-x.x.x，预发布结束以后，然后合并进Develop和Master分支。具体可以参考git：分支管理策略
- GitLab将自动将这个版本的代码打包生成zip，tar.gz，tar.bz2并tar 从给定的GIT中标记存档源代码
Release title：自定义发布标题。如果未提供标题，则使用发行版的标签名称。
Milestones：将里程碑相关联
Release notes(发行说明说明)：
- 每个版本都有说明。您可以添加任何您喜欢的文本
- 但是我们建议您添加一个变更日志来描述发行版本的内容。这可以帮助用户快速扫描您发布的每个发行版之间的差异
  
  Release assets：
GitLab自动生成zip，tar.gz，tar.bz2并tar 从给定的GIT中标记存档源代码。这些是只读资产
Links：链接是可以指向您喜欢的任何内容的任何URL：文档，内置二进制文件或其他相关材料。这些可以是您的GitLab实例的内部或外部链接。

效果如下：
Evidence collection：每次创建发行版时，GitLab都会拍摄与之相关的数据快照。此数据保存在JSON文件中，称为发布证据。该功能包括测试工件和链接的里程碑，以促进内部流程，例如外部审核。