Gitpod介绍

发布于: 8/22/2022 阅读大约需要3分钟

可以使用 gitpod.io/#/你的GitHub地址来在线开发你的GitHub项目
免费版有以下特性:

  • 每个月50个小时的使用时间
  • 公开 & 私有库
  • 可以同时打开4个工作空间
  • 闲置30分钟自动下线

开始使用

  1. 我们使用GitHub账号授权登录后进入到 Workspaces 页面进行创建工作空间

image.png

  1. 点击 New Workspace 后在弹窗中选择自己需要使用 Gitpod 的仓库
  2. 等待加载完成就进入到一个在线vscode页面可以进行开发了

因为Gitpod会在加载完毕后启动你的项目, 所以刚启动项目的时候右下角可能会弹出以下提示:
image.png
第一个是因为Gitpod检测到你项目启动的端口号, 询问是否需要将该URL转为公共,这样你就可以分享给你的团队成员进行访问。
下面是询问你是否需要在你本机的VSCode打开该项目.

Gitpod在配置你项目的时候会创建一个 .gitpod.yml文件用于存放其设置, 该文件具体可配置项如下:

.gitpod.yml配置

字段类型说明默认值可选值
checkoutLocationstring告诉GitPod从哪里检出代码,相对于 /workspace/workspace
gitConfigobject定义工作区的git配置, 可以参考git-scm
githubobject配置 GitHub Gitpod app. 用于为 GitHub 仓库配置持续预构建
prebuilds.addBadgeboolean在PR时是否在描述中添加一个Open in Gitpod按钮false
prebuilds.branchesboolean是否为所有分支创建预构建(prebuilds)false
prebuilds.masterbooleanGitpod是否为默认分支创建预构建true
prebuilds.pullRequestsboolean定义Gitpod是否为原始仓库的PR创建预构建。true
prebuilds.pullRequestsFromForksboolean定义Gitpod是否为来自forks的PR创建预构建false
imageobjectstring工作空间的默认镜像gitpod/workspace-full
image.filestring自定义docker镜像,例子参考
image.contextstring可选,当你想要向Docker镜像拷贝文件时,你可以设置该字段
portsarray配置Gitpod对应用端口的处理方式
port.onOpenstring当Gitpod检测到对应端口时的下一步操作open-browser,open-preview
notify,ignore
port.portnumberstring定义单个端口或端口范围: 3000-3100
port.visibilitystring端口可见性. 设置 public可以将URL分享给其他团队成员.private
tasksarray定义Gitpod如何预构建(准备与构建)你的项目, 每个任务都会在各自的终端中打开
task.beforestringinitcommand之前运行的命令行命令.
该命令每次启动都会执行。如果该任务失败,它下面任务将不会执行。
task.initstringbefore之后, command之前运行的命令.
该命令只会执行一次。
task.commandstringinitbefore之后运行的主命令行命令.
每次启动都会执行, 且不需要被终止.
task.envstring定义在workspace中可用的环境变量.环境变量参考
namestring任务名称
openModestring配置终端相对于上一个任务的打开方式tab-after, tab-before
split-right, split-left
vscode.extensionsarray用于配置vscode扩展. 需要以 ${publisher}.${name}方式定义.
比如 vscodevim.vim

字段配置例子

github:
  prebuilds:
    master: true
    branches: true
    pullRequests: true
    pullRequestsFromForks: true
    addCheck: false
    addComment: false
    addBadge: true
tasks:
  - before: sh ./scripts/setup.sh
    init: npm install
    command: npm run dev
  - name: Database
    init: sh ./scripts/seed-database.sh
    command: npm start-db
    env:
      DB_HOST: localhost:3306
      DB_USER: readOnlyUser

Chrome插件

chrome网上应用店 - Gitpod

相关链接

gitpod.io