Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gitpod-io/browser-extension
The browser extension for gitpod.io. Works with Chrome and Firefox.
https://github.com/gitpod-io/browser-extension
Last synced: 7 days ago
JSON representation
The browser extension for gitpod.io. Works with Chrome and Firefox.
- Host: GitHub
- URL: https://github.com/gitpod-io/browser-extension
- Owner: gitpod-io
- License: mit
- Created: 2019-11-01T16:01:22.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-17T10:40:41.000Z (25 days ago)
- Last Synced: 2024-12-28T11:07:19.882Z (14 days ago)
- Language: TypeScript
- Homepage: https://github.com/gitpod-io/gitpod
- Size: 2.35 MB
- Stars: 153
- Watchers: 16
- Forks: 81
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Gitpod Browser extension
[](https://gitpod.io/#https://github.com/gitpod-io/browser-extension)
This is the browser extension for Gitpod. It supports Chrome (see [Chrome Web Store](https://chrome.google.com/webstore/detail/dodmmooeoklaejobgleioelladacbeki/)), Firefox (see [Firefox Add-ons](https://addons.mozilla.org/firefox/addon/gitpod/)) and Edge (see [how to install Chrome extensions](https://support.microsoft.com/help/4538971/microsoft-edge-add-or-remove-extensions)), and adds a **Gitpod** button to the configured GitLab, GitHub and Bitbucket installations (defaults to `gitlab.com`, `github.com` and `bitbucket.org`) 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`](https://github.com/gitpod-io/gitpod) repository.
You can use the [`component: browser-extension`](https://github.com/gitpod-io/gitpod/issues?q=is%3Aissue+is%3Aopen+extension+label%3A%22component%3A+browser-extension%22) 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](https://github.com/gitpod-io/browser-extension/blob/se/plasmo/test/src/button-contributions.spec.ts#L39)
- try out changes like this:
1. run `pnpm build`
1. run `pnpm watch-prod` and download the built binary for your system (local machine)
1. run the binary anywhere on your local machine to sync the extension folder locally.
1. open Chrome and go to `chrome://extensions/`
1. enable `Developer mode` (top right)
1. click `Load unpacked` (top left) and select the folder you just downloaded
1. now you can test your changes
1. repeat step 1 and 2 and [reload the extension](chrome://extensions/) 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 --target=chrome-mv3 # or --target=firefox-mv2
pnpm package --target=chrome-mv3 # or --target=firefox-mv2
```
#### Note about `--target=firefox-mv2`
To generate a proper `manifest.json` file for Firefox, execute the following script first. It ensures that the manifest file is generated with MV2-compatible fields.
```
./scripts/firefox-mv2.sh
```
### Testing
You can test the extension without publishing to the store. Before uploading the bundle to the browser, make sure to [build](#build) the code, then follow these steps:
#### For Chrome
1. Open Chrome
2. Click Settings -> Extensions -> Load unpacked
3. Select the `chrome-mv3-prod` folder inside of `build/`
#### For Firefox
1. Open Firefox
1. Go to `about:debugging#/runtime/this-firefox`
1. Click Load Temporary Add-on -> Select the `firefox-mv2-prod.zip` file. Please note, that some features (like extension settings) will not work.
## 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 `package.json`
1. Push your changes to `main`
1. Create a tag `vX.Y.Z`
1. Compose a list of changes using the list of commits that were pushed since last version
1. [Create a new release](https://github.com/gitpod-io/browser-extension/releases/new), listing changes:
```yaml
### Changes
- Change/Fix A
- Change/Fix B
- Change/Fix C
### Credits
Thanks to @{EXTERNAL_CONTRIBUTOR_USERNAME} for helping! 🍊
```
For Firefox, our [GitHub Action](https://github.com/gitpod-io/browser-extension/blob/main/.github/workflows/submit.yml) should take care of publishing for us. You can trigger a release (either staging or production) from the [workflow's tab](https://github.com/gitpod-io/browser-extension/actions/workflows/submit.yml).
For Chrome:
1. Using your Google account, open the [`gitpod-browser-extension Google Group`](https://groups.google.com/g/gitpod-browser-extension)
2. If you don't have access, reach out for [help in Slack](https://gitpod.slack.com/archives/C020VCB0U5A)
3. Once you are in the Google Group, make sure to "Switch to Gitpod" in the top navbar
4. Click "Upload new package"
5. Upload the zip file (`chrome-mv3-prod.zip`) and submit
6. Wait a few hours for the review to happen!