This page contains information about releasing browser extensions for different browsers and creating your developer accounts.

Releasing Browser Extensions

Chrome

Deployment to the Chrome web store happen automatically in CI when the bext/release branch is updated.

Firefox

The release process for Firefox is currently semi-automated.

When the bext/release branch is updated, our build pipeline will trigger a build for the Firefox extension (take a note of the commit sha, we'll need it later). The build will trigger this script which will create a bundle, sign it and upload it to the Google Cloud Storage. Once the bundle is created, we upload it to the Mozilla Add-on page. Once the bundle is uploaded, we need to upload the source code as well. On your local copy, navigate to sourcegraph/client/browser/scripts/create-source-zip.js and modify the commitId variable (use the sha from earlier). Once the variable is modified, run this script. It will generate a sourcegraph.zip in the folder. Upload this zip to the Mozilla Add-on page and wait for approval.

Safari

The release process for Safari is currently not automated.

!! Before you start !!

  • Navigate to https://appstoreconnect.apple.com/apps.
  • You should see Sourcegraph for Safari.
    • If not, you should first ask a team member to add you to our Apple Developer group. They can send you an invitation to create an account.
  • Once you created a Sourcegraph associated developer account, make sure you add this account to Xcode accounts.

Steps:

  1. On your terminal navigate to ./sourcegraph/client/browser.
  2. Run the command yarn run build.
  3. Build will generate an Xcode project under ./sourcegraph/client/browser/build/Sourcegraph for Safari.
    1. If you run into Xcode related errors, make sure that you've downloaded Xcode from the app store, opened it and accepted the license/terms agreements.
  4. Open the project using Xcode.
  5. Navigate to the General settings tab.
  6. Select the target Sourcegraph for Safari.
    1. Change App Category to Developer Tools.
    2. Increment the Version & Build numbers. You can find the current numbers on the App Store Connect page.
  7. Select the target Sourcegraph for Safari Extension.
    1. Increment the Version & Build numbers. You can find the current numbers on the App Store Connect page.
  8. Open Assets.xcassets from the file viewer and select AppIcon. We need to upload the 512x512px & 1024x1024px version icons for the Mac Store. Drag & drop the files from Drive to the corresponding slots.
  9. On the menu bar, navigate to Product > Achive. Once successful, the Archives modal will appear. If you ever want to re-open this modal, you can do so by navigating to the Window > Organizier on the menu bar.
  10. With the latest build selected, click on the validate button.
  11. Choose SOURCEGRAPH INC from the dropdown and click next.
  12. Make sure uploading the symbols is checked and click next.
  13. Make sure automatically managing the signing is checked and click next.
    1. If this is your first time signing the package, you need to create your own local distribution key.
  14. Once the validation is complete, click on the Distribute App.
  15. Make sure App Store Connect is selected and click next.
  16. Make sure upload is selected and click next.
  17. Choose SOURCEGRAPH INC from the dropdown and click next.
  18. Make sure uploading the symbols is checked and click next.
  19. Make sure automatically managing the signing is checked and click next.
  20. Validate everything on the summary page and click upload
  21. Once successful, you can navigate to the app store connect webpage and see a new version being processed on the Mac Build Activity tab.
  22. Once processing is done, navigate to App Store tab and click on the blue + symbol, located next to the macOS App label.
  23. Enter the version number we've previously used on step 6 and click create.
  24. A new version will appear on the left menu. Click on this new version and fill out the information textbox with a summary of updates.
  25. Scroll down to the build section and click on the blue + symbol.
  26. Select the build we've just uploaded and click done. (ignore compliance warning)
    1. Since our app communicates using https, we qualify for the export compliance. Select Yes and click next.
    2. Our use of encryption is exempt from regulations. Select Yes and click next.
  27. We can now click the Save button and Submit for Review.

Creating developer accounts for browser extensions

Firefox

Safari

  • Ask a team member to add you to our Apple Developer group. They can send you an invitation from (App Store Connect)[https://appstoreconnect.apple.com/] portal.

Chrome