Merge pull request #334 from popey/patch-1

Added section on installing the snap

.travis.yml

@@ -15,7 +15,7 @@ matrix:
     - os: osx
 
 language: node_js
-node_js: "10"
+node_js: "12"
 
 before_install:
   - curl -o- -L https://yarnpkg.com/install.sh | bash

DOCS.md

@@ -65,9 +65,9 @@ To copy your settings manually:
 - Copy the contents of settings.json into the same place in VSCodium
 
 ## <a id="portable"></a>How do I run VSCodium in portable mode?
-You can follow the [Portable Mode instructions](https://code.visualstudio.com/docs/editor/portable) from the Visual Studio Code website. For Windows and Linux the instructions can be followed as written. For Mac OS, portable mode is enabled by the existence of a specially named folder. For Visual Studio Code that folder name is `code-portable-data`. For VSCodium, that folder name is `codium-portable-data`. 
+You can follow the [Portable Mode instructions](https://code.visualstudio.com/docs/editor/portable) from the Visual Studio Code website. 
-
+- **Windows** / **Linux** : the instructions can be followed as written.
-So to enable portable mode for VSCodium on Mac OS, follow the instructions outlined in the link above, but create a folder named `codium-portable-data` instead of `code-portable-data`.
+- **macOS** : portable mode is enabled by the existence of a specially named folder. For Visual Studio Code that folder name is `code-portable-data`. For VSCodium, that folder name is `codium-portable-data`. So to enable portable mode for VSCodium on Mac OS, follow the instructions outlined in the [link above](https://code.visualstudio.com/docs/editor/portable), but create a folder named `codium-portable-data` instead of `code-portable-data`.
 
 ## <a id="press-and-hold"></a>How do I press and hold a key and have it repeat in VSCodium (Mac)?
 

README.md

@@ -12,6 +12,8 @@
 [![build status](https://travis-ci.com/VSCodium/vscodium.svg?branch=master)](https://travis-ci.com/VSCodium/vscodium) 
 [![license](https://img.shields.io/github/license/VSCodium/vscodium.svg)](https://github.com/VSCodium/vscodium/blob/master/LICENSE)
 [![Gitter](https://img.shields.io/gitter/room/vscodium/vscodium.svg)](https://gitter.im/VSCodium/Lobby)
+[![codium](https://snapcraft.io//codium/badge.svg)](https://snapcraft.io/codium)
+[![codium](https://snapcraft.io//codium/trending.svg?name=0)](https://snapcraft.io/codium)
 
 </div>
 
@@ -22,6 +24,7 @@
   - [Install with Brew](#install-with-brew)
   - [Install with Chocolatey](#install-with-choco)
   - [Install with Scoop](#install-with-scoop)
+  - [Install with snap](#install-with-snap)
   - [Install with Package Manager](#install-with-package-manager)
   - [Install on Arch Linux](#install-on-arch-linux)
   - [Flatpak Option](#flatpak)
@@ -55,6 +58,13 @@ scoop bucket add extras
 scoop install vscodium
 ```
 
+#### <a id="install-with-snap"></a>Install with snap (Linux)
+VSCodium is available in the [Snap Store](https://snapcraft.io/) as [Codium](https://snapcraft.io/codium), published by the [Snapcrafters](https://github.com/snapcrafters/codium) community.
+If your Linux distribution has support for [snaps](https://snapcraft.io/docs/installing-snapd):
+```bash
+snap install codium
+```
+
 #### <a id="install-with-package-manager"></a>Install with Package Manager (Linux)
 You can always install using the downloads (deb, rpm, tar) on the [releases page](https://github.com/VSCodium/vscodium/releases), but you can also install using your favorite package manager and get automatic updates. [@paulcarroty](https://github.com/paulcarroty) has set up a repository with instructions [here](https://gitlab.com/paulcarroty/vscodium-deb-rpm-repo). Any issues installing VSCodium using your package manager should be directed to that repository's issue tracker. 
 

build.sh

@@ -19,63 +19,15 @@ if [[ "$SHOULD_BUILD" == "yes" ]]; then
   echo "LATEST_MS_COMMIT: ${LATEST_MS_COMMIT}"
   echo "BUILD_SOURCEVERSION: ${BUILD_SOURCEVERSION}"
 
-  cp -rp src/* vscode/
-  cd vscode || exit
-
   export npm_config_arch="$BUILDARCH"
   export npm_config_target_arch="$BUILDARCH"
-  ../update_settings.sh
 
-  # apply patches
+  ./prepare_vscode.sh
-  patch -u src/vs/platform/update/electron-main/updateService.win32.ts -i ../patches/update-cache-path.patch
 
-  yarn
+  cd vscode || exit
-  yarn postinstall
-  mv product.json product.json.bak
-
-  # set fields in product.json
-  tipsAndTricksUrl='setpath(["tipsAndTricksUrl"]; "https://go.microsoft.com/fwlink/?linkid=852118")'
-  twitterUrl='setpath(["twitterUrl"]; "https://go.microsoft.com/fwlink/?LinkID=533687")'
-  requestFeatureUrl='setpath(["requestFeatureUrl"]; "https://go.microsoft.com/fwlink/?LinkID=533482")'
-  documentationUrl='setpath(["documentationUrl"]; "https://go.microsoft.com/fwlink/?LinkID=533484#vscode")'
-  introductoryVideosUrl='setpath(["introductoryVideosUrl"]; "https://go.microsoft.com/fwlink/?linkid=832146")'
-  extensionAllowedBadgeProviders='setpath(["extensionAllowedBadgeProviders"]; ["api.bintray.com", "api.travis-ci.com", "api.travis-ci.org", "app.fossa.io", "badge.fury.io", "badge.waffle.io", "badgen.net", "badges.frapsoft.com", "badges.gitter.im", "badges.greenkeeper.io", "cdn.travis-ci.com", "cdn.travis-ci.org", "ci.appveyor.com", "circleci.com", "cla.opensource.microsoft.com", "codacy.com", "codeclimate.com", "codecov.io", "coveralls.io", "david-dm.org", "deepscan.io", "dev.azure.com", "flat.badgen.net", "gemnasium.com", "githost.io", "gitlab.com", "godoc.org", "goreportcard.com", "img.shields.io", "isitmaintained.com", "marketplace.visualstudio.com", "nodesecurity.io", "opencollective.com", "snyk.io", "travis-ci.com", "travis-ci.org", "visualstudio.com", "vsmarketplacebadge.apphb.com", "www.bithound.io", "www.versioneye.com"])'
-  updateUrl='setpath(["updateUrl"]; "https://vscodium.now.sh")'
-  releaseNotesUrl='setpath(["releaseNotesUrl"]; "https://go.microsoft.com/fwlink/?LinkID=533483#vscode")'
-  keyboardShortcutsUrlMac='setpath(["keyboardShortcutsUrlMac"]; "https://go.microsoft.com/fwlink/?linkid=832143")'
-  keyboardShortcutsUrlLinux='setpath(["keyboardShortcutsUrlLinux"]; "https://go.microsoft.com/fwlink/?linkid=832144")'
-  keyboardShortcutsUrlWin='setpath(["keyboardShortcutsUrlWin"]; "https://go.microsoft.com/fwlink/?linkid=832145")'
-  quality='setpath(["quality"]; "stable")'
-  extensionsGallery='setpath(["extensionsGallery"]; {"serviceUrl": "https://marketplace.visualstudio.com/_apis/public/gallery", "cacheUrl": "https://vscode.blob.core.windows.net/gallery/index", "itemUrl": "https://marketplace.visualstudio.com/items"})'
-  nameShort='setpath(["nameShort"]; "VSCodium")'
-  nameLong='setpath(["nameLong"]; "VSCodium")'
-  linuxIconName='setpath(["linuxIconName"]; "vscodium")'
-  applicationName='setpath(["applicationName"]; "codium")'
-  win32MutexName='setpath(["win32MutexName"]; "vscodium")'
-  win32DirName='setpath(["win32DirName"]; "VSCodium")'
-  win32NameVersion='setpath(["win32NameVersion"]; "VSCodium")'
-  win32RegValueName='setpath(["win32RegValueName"]; "VSCodium")'
-  win32AppUserModelId='setpath(["win32AppUserModelId"]; "Microsoft.VSCodium")'
-  win32ShellNameShort='setpath(["win32ShellNameShort"]; "VSCodium")'
-  win32x64UserAppId='setpath (["win32x64UserAppId"]; "{{2E1F05D1-C245-4562-81EE-28188DB6FD17}")'
-  urlProtocol='setpath(["urlProtocol"]; "vscodium")'
-  extensionAllowedProposedApi='setpath(["extensionAllowedProposedApi"]; getpath(["extensionAllowedProposedApi"]) + ["ms-vsliveshare.vsliveshare"])'
-
-  product_json_changes="${tipsAndTricksUrl} | ${twitterUrl} | ${requestFeatureUrl} | ${documentationUrl} | ${introductoryVideosUrl} | ${extensionAllowedBadgeProviders} | ${updateUrl} | ${releaseNotesUrl} | ${keyboardShortcutsUrlMac} | ${keyboardShortcutsUrlLinux} | ${keyboardShortcutsUrlWin} | ${quality} | ${extensionsGallery} | ${nameShort} | ${nameLong} | ${linuxIconName} | ${applicationName} | ${win32MutexName} | ${win32DirName} | ${win32NameVersion} | ${win32RegValueName} | ${win32AppUserModelId} | ${win32ShellNameShort} | ${win32x64UserAppId} | ${urlProtocol} | ${extensionAllowedProposedApi}"
-  cat product.json.bak | jq "${product_json_changes}" > product.json
-  cat product.json
-  ../undo_telemetry.sh
 
   export NODE_ENV=production
 
-  if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
-    # microsoft adds their apt repo to sources
-    # unless the app name is code-oss
-    # as we are renaming the application to vscodium
-    # we need to edit a line in the post install template
-    sed -i "s/code-oss/codium/" resources/linux/debian/postinst.template
-  fi
-
   # these tasks are very slow, so using a keep alive to keep travis alive
   if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
     keep_alive_small &

prepare_vscode.sh

@@ -0,0 +1,58 @@
+#!/bin/bash
+
+export npm_config_arch="$BUILDARCH"
+export npm_config_target_arch="$BUILDARCH"
+
+cp -rp src/* vscode/
+cd vscode || exit
+
+../update_settings.sh
+
+# apply patches
+patch -u src/vs/platform/update/electron-main/updateService.win32.ts -i ../patches/update-cache-path.patch
+
+yarn --frozen-lockfile
+yarn postinstall
+mv product.json product.json.bak
+
+# set fields in product.json
+tipsAndTricksUrl='setpath(["tipsAndTricksUrl"]; "https://go.microsoft.com/fwlink/?linkid=852118")'
+twitterUrl='setpath(["twitterUrl"]; "https://go.microsoft.com/fwlink/?LinkID=533687")'
+requestFeatureUrl='setpath(["requestFeatureUrl"]; "https://go.microsoft.com/fwlink/?LinkID=533482")'
+documentationUrl='setpath(["documentationUrl"]; "https://go.microsoft.com/fwlink/?LinkID=533484#vscode")'
+introductoryVideosUrl='setpath(["introductoryVideosUrl"]; "https://go.microsoft.com/fwlink/?linkid=832146")'
+extensionAllowedBadgeProviders='setpath(["extensionAllowedBadgeProviders"]; ["api.bintray.com", "api.travis-ci.com", "api.travis-ci.org", "app.fossa.io", "badge.fury.io", "badge.waffle.io", "badgen.net", "badges.frapsoft.com", "badges.gitter.im", "badges.greenkeeper.io", "cdn.travis-ci.com", "cdn.travis-ci.org", "ci.appveyor.com", "circleci.com", "cla.opensource.microsoft.com", "codacy.com", "codeclimate.com", "codecov.io", "coveralls.io", "david-dm.org", "deepscan.io", "dev.azure.com", "flat.badgen.net", "gemnasium.com", "githost.io", "gitlab.com", "godoc.org", "goreportcard.com", "img.shields.io", "isitmaintained.com", "marketplace.visualstudio.com", "nodesecurity.io", "opencollective.com", "snyk.io", "travis-ci.com", "travis-ci.org", "visualstudio.com", "vsmarketplacebadge.apphb.com", "www.bithound.io", "www.versioneye.com"])'
+updateUrl='setpath(["updateUrl"]; "https://vscodium.now.sh")'
+releaseNotesUrl='setpath(["releaseNotesUrl"]; "https://go.microsoft.com/fwlink/?LinkID=533483#vscode")'
+keyboardShortcutsUrlMac='setpath(["keyboardShortcutsUrlMac"]; "https://go.microsoft.com/fwlink/?linkid=832143")'
+keyboardShortcutsUrlLinux='setpath(["keyboardShortcutsUrlLinux"]; "https://go.microsoft.com/fwlink/?linkid=832144")'
+keyboardShortcutsUrlWin='setpath(["keyboardShortcutsUrlWin"]; "https://go.microsoft.com/fwlink/?linkid=832145")'
+quality='setpath(["quality"]; "stable")'
+extensionsGallery='setpath(["extensionsGallery"]; {"serviceUrl": "https://marketplace.visualstudio.com/_apis/public/gallery", "cacheUrl": "https://vscode.blob.core.windows.net/gallery/index", "itemUrl": "https://marketplace.visualstudio.com/items"})'
+nameShort='setpath(["nameShort"]; "VSCodium")'
+nameLong='setpath(["nameLong"]; "VSCodium")'
+linuxIconName='setpath(["linuxIconName"]; "vscodium")'
+applicationName='setpath(["applicationName"]; "codium")'
+win32MutexName='setpath(["win32MutexName"]; "vscodium")'
+win32DirName='setpath(["win32DirName"]; "VSCodium")'
+win32NameVersion='setpath(["win32NameVersion"]; "VSCodium")'
+win32RegValueName='setpath(["win32RegValueName"]; "VSCodium")'
+win32AppUserModelId='setpath(["win32AppUserModelId"]; "Microsoft.VSCodium")'
+win32ShellNameShort='setpath(["win32ShellNameShort"]; "VSCodium")'
+win32x64UserAppId='setpath (["win32x64UserAppId"]; "{{2E1F05D1-C245-4562-81EE-28188DB6FD17}")'
+urlProtocol='setpath(["urlProtocol"]; "vscodium")'
+extensionAllowedProposedApi='setpath(["extensionAllowedProposedApi"]; getpath(["extensionAllowedProposedApi"]) + ["ms-vsliveshare.vsliveshare"])'
+
+product_json_changes="${tipsAndTricksUrl} | ${twitterUrl} | ${requestFeatureUrl} | ${documentationUrl} | ${introductoryVideosUrl} | ${extensionAllowedBadgeProviders} | ${updateUrl} | ${releaseNotesUrl} | ${keyboardShortcutsUrlMac} | ${keyboardShortcutsUrlLinux} | ${keyboardShortcutsUrlWin} | ${quality} | ${extensionsGallery} | ${nameShort} | ${nameLong} | ${linuxIconName} | ${applicationName} | ${win32MutexName} | ${win32DirName} | ${win32NameVersion} | ${win32RegValueName} | ${win32AppUserModelId} | ${win32ShellNameShort} | ${win32x64UserAppId} | ${urlProtocol} | ${extensionAllowedProposedApi}"
+cat product.json.bak | jq "${product_json_changes}" > product.json
+cat product.json
+
+../undo_telemetry.sh
+
+if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
+  # microsoft adds their apt repo to sources
+  # unless the app name is code-oss
+  # as we are renaming the application to vscodium
+  # we need to edit a line in the post install template
+  sed -i "s/code-oss/codium/" resources/linux/debian/postinst.template
+fi

win32-build.yml

@@ -1,7 +1,7 @@
 steps:
 - task: NodeTool@0 
   inputs:
-    versionSpec: '10.x'
+    versionSpec: "12.13.0"
 - script: |
     choco install jq 
   displayName: 'install jq from choco'