Skip to content

Commit e3cec52

Browse files
filiptroniceksvenefftinge
authored andcommitted
Update README
1 parent 2ce3651 commit e3cec52

File tree

1 file changed

+31
-74
lines changed

1 file changed

+31
-74
lines changed

README.md

Lines changed: 31 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Gitpod Browser extension
2+
23
[![Setup Automated](https://img.shields.io/badge/setup-automated-blue?logo=gitpod)](https://gitpod.io/#https://github.com/gitpod-io/browser-extension)
34

45
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`, `bitbucket.org`, and `gitlab.cn`) which immediately creates a Gitpod workspace for the current Git context:
56

6-
![Gitpodify](./docs/github-injected.png "Gitpodify")
7+
![Gitpodify](./docs/github-injected.png "Gitpodify")
78

89
### Issues
910

@@ -12,18 +13,18 @@ You can use the [`component: browser-extension`](https://github.com/gitpod-io/gi
1213

1314
### Development
1415

15-
To make changes and test them using Gitpod itself:
16-
17-
- add test cases to the [unit test](https://github.com/gitpod-io/browser-extension/blob/se/plasmo/test/src/button-contributions.spec.ts#L39)
18-
- try out changes like this:
19-
1. run `pnpm build`
20-
1. run `pnpm watch-prod` and download the built binary for your system (local machine)
21-
1. run the binary aywhere on your local machine tosync the extension folder locally.
22-
1. open Chrome and go to `chrome://extensions/`
23-
1. enable `Developer mode` (top right)
24-
1. click `Load unpacked` (top left) and select the folder you just downloaded
25-
1. now you can test your changes
26-
1. repeat step 1 and 2 and [reload the extension](chrome://extensions/) whenever you want to test new changes
16+
To make changes and test them using Gitpod itself:
17+
18+
- add test cases to the [unit test](https://github.com/gitpod-io/browser-extension/blob/se/plasmo/test/src/button-contributions.spec.ts#L39)
19+
- try out changes like this:
20+
1. run `pnpm build`
21+
1. run `pnpm watch-prod` and download the built binary for your system (local machine)
22+
1. run the binary anywhere on your local machine to sync the extension folder locally.
23+
1. open Chrome and go to `chrome://extensions/`
24+
1. enable `Developer mode` (top right)
25+
1. click `Load unpacked` (top left) and select the folder you just downloaded
26+
1. now you can test your changes
27+
1. repeat step 1 and 2 and [reload the extension](chrome://extensions/) whenever you want to test new changes
2728

2829
#### Build
2930

@@ -41,22 +42,15 @@ You can test the extension without publishing to the store. Before uploading the
4142

4243
For Chrome:
4344

44-
1. Rename `gitpod.xpi` to `gitpod.zip`
45-
1. Unzip `gitpod.zip`
4645
1. Open Chrome
47-
1. Click Settings -> Extensions -> Load unpacked
48-
1. Select the unzipped folder
46+
2. Click Settings -> Extensions -> Load unpacked
47+
3. Select the `chrome-mv3-prod` folder inside of `build/`
4948

5049
For Firefox
5150

5251
1. Open Firefox
5352
1. Go to `about:debugging#/runtime/this-firefox`
54-
1. Click Load Temporary Add-on -> Select the `gitpod.xpi` file
55-
56-
For Safari (Experimental 🧪)
57-
58-
1. Open `Gitpod/Gitpod.xcodeproj`
59-
1. Run the project with `cmd` + `r`. ⚠️ _Safari must have [**Allow Unsigned Extensions**](https://developer.apple.com/documentation/safariservices/safari_app_extensions/building_a_safari_app_extension) enabled._
53+
1. Click Load Temporary Add-on -> Select the `firefox-mv2-prod.zip` file. Please note, that some features (like extension settings) will not work.
6054

6155
## Release
6256

@@ -70,62 +64,25 @@ To release a new version, follow these steps:
7064
1. Compose a list of changes using the list of commits that were pushed since last version
7165
1. [Create a new release](https://github.com/gitpod-io/browser-extension/releases/new), listing changes:
7266

73-
```yaml
74-
### Changes
75-
76-
- Change/Fix A
77-
- Change/Fix B
78-
- Change/Fix C
67+
```yaml
68+
### Changes
7969

80-
### Credits
70+
- Change/Fix A
71+
- Change/Fix B
72+
- Change/Fix C
8173

82-
Thanks to @{EXTERNAL_CONTRIBUTOR_USERNAME} for helping! 🍊
83-
```
74+
### Credits
8475

85-
1. Start a new workspace using Gitpod
86-
1. Download `gitpod.xpi` which is just been generated in your workspace
76+
Thanks to @{EXTERNAL_CONTRIBUTOR_USERNAME} for helping! 🍊
77+
```
8778

88-
For Firefox:
89-
90-
1. Login to [addons.mozilla.org](https://addons.mozilla.org/) with user `[email protected]`
91-
1. Click on "See all versions"
92-
1. Click on "Upload New Version"
93-
1. Upload the `gitpod.xpi` file
94-
1. Select only "Firefox" (leave empty "Firefox for Android")
95-
1. Answer "No" at the question “Do you use any of the following in your extension?”
96-
1. Click "Continue"
97-
1. Click "Submit Version"
98-
1. Wait a few hours for the review to happen!
79+
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.
9980

10081
For Chrome:
10182

10283
1. Using your Google account, open the [`gitpod-browser-extension Google Group`](https://groups.google.com/g/gitpod-browser-extension)
103-
1. If you don't have access, reach out for [help in Slack](https://gitpod.slack.com/archives/C020VCB0U5A)
104-
1. Once you are in the Google Group, make sure to "Switch to Gitpod" in the top navbar
105-
1. Rename `gitpod.xpi` to `gitpod.zip`
106-
1. Click "Upload new package"
107-
1. Upload the zip file and submit
108-
1. Wait a few hours for the review to happen!
109-
110-
111-
### Safari
112-
113-
#### ⚠️ A machine running macOS and [Xcode 12+](https://developer.apple.com/xcode/) installed is required!
114-
115-
First, run the following to install dependencies and build the web extension:
116-
117-
```
118-
yarn install && yarn build && yarn package
119-
```
120-
121-
Then run the `build:safari` command to build the Safari extension around the web extension:
122-
123-
```
124-
yarn build:safari
125-
```
126-
127-
![Confirm Safari](./docs/safari-confirm.png "Confirm Safari")
128-
129-
Hit `enter` when presented with this screen.
130-
131-
`Xcode` will open the `Gitpod.xcodeproj` automatically if it's installed.
84+
2. If you don't have access, reach out for [help in Slack](https://gitpod.slack.com/archives/C020VCB0U5A)
85+
3. Once you are in the Google Group, make sure to "Switch to Gitpod" in the top navbar
86+
4. Click "Upload new package"
87+
5. Upload the zip file (`chrome-mv3-prod.zip`) and submit
88+
6. Wait a few hours for the review to happen!

0 commit comments

Comments
 (0)