跳转至

OPRTING Docs

欢迎使用 OPRTING Docs

这个文档集主要目的是:

高效协同：GitLab、Linux 与 VS Code

1. 平台准备

在开始之前，请确保您已经完成以下准备工作：

  • GitLab：在 GitLab 上创建一个新的空项目；

  • Linux 本地服务器：（推荐使用 Debian Linux）确保您的 Debian 系统已经安装了 Git。如果无法确定，请运行以下命令进行检查: 

    1
    $ git --version

    如果命令返回 Git 的版本号（例如：git version 2.30.2），则表示 Git 已安装。如果返回“命令未找到”之类的错误，请运行以下命令进行安装:

    1
2
    $ sudo apt update
$ sudo apt install git

  • VS Code：在本地电脑上安装 VS Code，并安装 Remote - SSH 扩展。这个扩展是实现远程开发的关键。

2. 初始化 Git 仓库与远程连接

这一步将在 Debian 本地服务器上初始化一个 Git 仓库，并将其与 GitLab 上的远程仓库关联。

  • 在 Debian 服务器上创建工作目录：打开 Debian 终端，创建一个项目文件夹并进入该文件夹 
    1
2
    $ mkdir gitlab-project
$ cd gitlab-project
  • 初始化 Git 仓库：在项目文件夹中运行 git init 命令，将其初始化为一个 Git 仓库 
    1
    $ git init
  • 配置远程仓库：将本地仓库与您在 GitLab 上创建的空项目关联起来。请将 your-gitlab-url 替换为您的实际 GitLab 项目 URL 
    1
    $ git remote add origin <your-gitlab-url>
  • 添加文件并进行首次提交：创建一个示例文件，比如一个 README.md，然后将其添加到 Git 暂存区并提交 
    1
2
3
    $ echo "# My GitLab Project" > README.md
$ git add .
$ git commit -m "Initial commit"

  • 推送到 GitLab：将本地的 main 分支推送到 GitLab 上的 origin 远程仓库。git push -u origin main 会将本地的 main 分支与远程的 main 分支建立关联，以后您只需运行 git push 即可 

    1
    $ git push -u origin main

    您可能需要输入您的 GitLab 用户名和密码或个人访问令牌（Personal Access Token）

3. 使用 VS Code 远程访问 Debian

现在，您可以配置 VS Code，通过 SSH 连接到您的 Debian 服务器，直接在其上进行开发，就好像在本地一样。

  • 在 VS Code 中配置 SSH 连接：在 VS Code 中，点击左侧活动栏的远程资源管理器图标（通常是一个显示器和插头的图标），在顶部的下拉菜单中选择 SSH Targets，然后点击 + 号添加一个新的 SSH 连接
  • 输入您的 SSH 连接命令：格式为 ssh 用户名@服务器IP地址。例如：ssh user@192.168.1.100
  • VS Code 会提示您选择一个 SSH 配置文件来保存此设置。选择一个即可
  • 连接到 Debian 服务器：在 SSH Targets 列表中找到您刚刚添加的服务器，点击旁边的连接图标
  • VS Code 将打开一个新的窗口，并提示您输入 SSH 密码，成功连接后，您会在左下角看到服务器的 IP 地址
  • 打开您的项目文件夹：连接成功后，点击 文件 -> 打开文件夹（或使用快捷键 Ctrl+K Ctrl+O）
  • 输入您在 Debian 上创建的项目路径，例如 /home/user/gitlab-project，然后点击确定

现在，您就可以在 VS Code 中看到您的项目文件，并且所有操作（如编辑、保存、使用集成终端）都直接在 Debian 服务器上进行。

4. 日常开发工作流

在您完成上述设置后，日常的开发工作流将变得非常顺畅：

  • 在 VS Code 中修改或创建文件;
  • 使用 VS Code 内置的终端，它已经连接到您的 Debian 服务器;
  • 在终端中，使用以下 Git 命令来管理您的代码： 
    1
2
3
4
    $ git add .                            # 将所有修改添加到暂存区
$ git commit -m "Your commit message"  # 提交修改。
$ git pull                             # 在推送前，先拉取远程仓库的最新代码，避免冲突
$ git push                             # 将本地提交推送到 GitLab

这个工作流程让您能够利用 VS Code 强大的编辑器功能，同时又确保所有代码都安全地存储在您的 Debian 服务器上，并通过 Git 和 GitLab 进行版本控制。