feat: update required protocol version to 12 [IDE-426] [IDE-376] (#187)

* feat: update required protocol version to 12 [IDE-426] [IDE-376]

* docs: synchronizing README from snyk/user-docs

* docs: update changelog

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: bastiandoetsch

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [2.2.0] - Unreleased
 ### Changes
+- update required protocol version to 12
+- integrate latest docs incl. troubleshooting
+
+## [2.2.0] - v20240619.131238
+### Changes
 - fixes the generated ignore id so that it is ignored during scanning  
 
 ## [2.2.0] - v20240529.110806

README.md

@@ -24,24 +24,17 @@ This page explains supported environments, support, and giving feedback and prov
 * Third-party[ dependency scanning (SCA, Snyk Open Source)](https://docs.snyk.io/ide-tools/eclipse-plugin/third-party-dependency-scanning-sca-snyk-open-source)
 * [Troubleshooting for the Eclipse plugin](https://docs.snyk.io/ide-tools/eclipse-plugin/troubleshooting-for-the-eclipse-plugin)
 
-## Where you can download the Eclipse plugin
+## Supported operating systems and architecture
 
-* **Eclipse Marketplace (recommended)**: [https://marketplace.eclipse.org/content/snyk-security-code%E2%80%8B-open-source%E2%80%8B-iac-configurations](https://marketplace.eclipse.org/content/snyk-security-code%E2%80%8B-open-source%E2%80%8B-iac-configurations)
-* Preview update site (CI/CD, on commit): [https://static.snyk.io/eclipse/preview](https://static.snyk.io/eclipse/preview)
-* Stable update site (weekly): [https://static.snyk.io/eclipse/stable](https://static.snyk.io/eclipse/stable)
-* Manual downloads: [https://github.com/snyk/snyk-eclipse-plugin/releases](https://github.com/snyk/snyk-eclipse-plugin/releases)
 
-**Signing Information for Jars**
+Snyk plugins are not supported on any operating system that has reached End Of Life (EOL) with the distributor. 
 
-If you want to verify the correct provenance of your download, verify the signing details from the Eclipse dialog using this data.
 
-<figure><img src="https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/image (134) (2) (1) (1) (1) (1) (1) (1) (1) (1).png" alt="The signing key details to verify the integrity and origin of the download plugin"><figcaption><p>The signing key details to verify the integrity and origin of the download plugin</p></figcaption></figure>
-
-The plugin runs on
+You can use the Eclipse plugin in the following environments:
 
-* macOS
-* Linux
-* Windows
+* Linux: AMD64 and ARM64
+* Windows: 386 and AMD64
+* MacOS: AMD64 and ARM64
 
 ## Versions of the plugin supported in Eclipse
 
@@ -59,13 +52,18 @@ The latest plugin version may not be supported in all Eclipse versions. Thus, if
 * For Snyk Code, the Eclipse plugin supports the languages and frameworks supported by Snyk Code. For more information, see [Supported languages, frameworks, and feature availability overview, Snyk Code section](https://docs.snyk.io/scan-applications/supported-languages-and-frameworks/supported-languages-frameworks-and-feature-availability-overview#code-analysis-snyk-code).
 * For Snyk IaC, the Eclipse plugin supports the following IaC templates: Terraform, Kubernetes, CloudFormation, and Azure Resource Manager.
 
-## Supported operating systems and architecture
+## Where you can download the Eclipse plugin
 
-You can use the Eclipse plugin in the following environments:
+* **Eclipse Marketplace (recommended)**: [https://marketplace.eclipse.org/content/snyk-security-code%E2%80%8B-open-source%E2%80%8B-iac-configurations](https://marketplace.eclipse.org/content/snyk-security-code%E2%80%8B-open-source%E2%80%8B-iac-configurations)
+* Preview update site (CI/CD, on commit): [https://static.snyk.io/eclipse/preview](https://static.snyk.io/eclipse/preview)
+* Stable update site (weekly): [https://static.snyk.io/eclipse/stable](https://static.snyk.io/eclipse/stable)
+* Manual downloads: [https://github.com/snyk/snyk-eclipse-plugin/releases](https://github.com/snyk/snyk-eclipse-plugin/releases)
 
-* Linux: AMD64 and ARM64
-* Windows: 386 and AMD64
-* MacOS: AMD64 and ARM64
+**Signing Information for Jars**
+
+If you want to verify the correct provenance of your download, verify the signing details from the Eclipse dialog using this data.
+
+<figure><img src="https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/image (134) (2) (1) (1) (1) (1) (1) (1) (1) (1).png" alt="The signing key details to verify the integrity and origin of the download plugin"><figcaption><p>The signing key details to verify the integrity and origin of the download plugin</p></figcaption></figure>
 
 ## How to install the Snyk Eclipse plugin
 

plugin/src/main/java/io/snyk/languageserver/LsConfigurationUpdater.java

@@ -2,6 +2,7 @@
 
 import java.io.File;
 
+import io.snyk.languageserver.download.LsBinaries;
 import org.apache.commons.lang3.SystemUtils;
 import org.eclipse.lsp4j.DidChangeConfigurationParams;
 
@@ -82,6 +83,7 @@ static class Settings {
         private final String osArch = SystemUtils.OS_ARCH;
         private final String osPlatform = SystemUtils.OS_NAME;
         private final String scanningMode;
+        private final String requiredProtocolVersion = LsBinaries.REQUIRED_LS_PROTOCOL_VERSION;
 
         public Settings(String activateSnykOpenSource, String activateSnykCode, String activateSnykIac, String insecure,
                         String endpoint, String additionalParams, String additionalEnv, String path, String sendErrorReports,
@@ -205,5 +207,9 @@ public String getOsPlatform() {
         public String getScanningMode() {
             return scanningMode;
         }
+
+        public String getRequiredProtocolVersion() {
+            return requiredProtocolVersion;
+        }
     }
 }

plugin/src/main/java/io/snyk/languageserver/download/LsBinaries.java

@@ -8,7 +8,7 @@
 
 public class LsBinaries {
   private static final Preferences PREFERENCES = Preferences.getInstance();
-  public static final String REQUIRED_LS_PROTOCOL_VERSION = "10";
+  public static final String REQUIRED_LS_PROTOCOL_VERSION = "12";
 
   public static URI getBaseUri() {
     return URI.create(PREFERENCES.getPref(CLI_BASE_URL));