Gitpod Browser extension

This is the browser extension for Gitpod. It supports Chrome (see Chrome Web Store), Firefox (see Firefox Add-ons) and Edge (see how to install Chrome extensions), and adds a Gitpod button to the configured GitLab, GitHub and Bitbucket installations (defaults to gitlab.com, github.com, bitbucket.org, and gitlab.cn) which immediately creates a Gitpod workspace for the current Git context:

Issues

We are currently tracking all issues related to the browser extension in the gitpod-io/gitpod repository. You can use the component: browser-extension label to search for relevant issues including feature proposals and bug reports.

Development

To make changes and test them using Gitpod itself:

• add test cases to the unit test
• try out changes like this:
  1. run pnpm build
  2. run pnpm watch-prod and download the built binary for your system (local machine)
  3. run the binary aywhere on your local machine tosync the extension folder locally.
  4. open Chrome and go to chrome://extensions/
  5. enable Developer mode (top right)
  6. click Load unpacked (top left) and select the folder you just downloaded
  7. now you can test your changes
  8. repeat step 1 and 2 and reload the extension whenever you want to test new changes

Build

The build happens automatically when you start a workspace but if you want to build explicitly, use these commands:

pnpm install
pnpm build
pnpm package

Testing

You can test the extension without publishing to the store. Before uploading the bundle to the browser, make sure to build the code, then follow these steps:

For Chrome:

1. Rename gitpod.xpi to gitpod.zip
2. Unzip gitpod.zip
3. Open Chrome
4. Click Settings -> Extensions -> Load unpacked
5. Select the unzipped folder

For Firefox

1. Open Firefox
2. Go to about:debugging#/runtime/this-firefox
3. Click Load Temporary Add-on -> Select the gitpod.xpi file

For Safari (Experimental 🧪)

1. Open Gitpod/Gitpod.xcodeproj
2. Run the project with cmd + r. ⚠️ Safari must have Allow Unsigned Extensions enabled.

Release

We currently publish the extension for Chrome and Firefox.

To release a new version, follow these steps:

1. Bump up the version value inside manifest.json

2. Push your changes to master

3. Create a tag vX.Y.Z

4. Compose a list of changes using the list of commits that were pushed since last version

5. Create a new release, listing changes:

   ### Changes
   
   - Change/Fix A
   - Change/Fix B
   - Change/Fix C
   
   ### Credits
   
   Thanks to @{EXTERNAL_CONTRIBUTOR_USERNAME} for helping! 🍊

6. Start a new workspace using Gitpod

7. Download gitpod.xpi which is just been generated in your workspace

For Firefox:

1. Login to addons.mozilla.org with user info@gitpod.io
2. Click on "See all versions"
3. Click on "Upload New Version"
4. Upload the gitpod.xpi file
5. Select only "Firefox" (leave empty "Firefox for Android")
6. Answer "No" at the question “Do you use any of the following in your extension?”
7. Click "Continue"
8. Click "Submit Version"
9. Wait a few hours for the review to happen!

For Chrome:

1. Using your Google account, open the gitpod-browser-extension Google Group
2. If you don't have access, reach out for help in Slack
3. Once you are in the Google Group, make sure to "Switch to Gitpod" in the top navbar
4. Rename gitpod.xpi to gitpod.zip
5. Click "Upload new package"
6. Upload the zip file and submit
7. Wait a few hours for the review to happen!

Safari

⚠️ A machine running macOS and Xcode 12+ installed is required!

First, run the following to install dependencies and build the web extension:

yarn install && yarn build && yarn package

Then run the build:safari command to build the Safari extension around the web extension:

yarn build:safari

Hit enter when presented with this screen.

Xcode will open the Gitpod.xcodeproj automatically if it's installed.