|
1 |
| - |
2 | 1 | ## Eclipse Plugin Release Steps
|
3 | 2 |
|
4 | 3 | **Protocol Version Verification**
|
5 | 4 |
|
6 |
| -- Ensure the Snyk Language Server Protocol version is correct in the plugin. |
| 5 | +- Ensure the Snyk Language Server Protocol version is correct in the plugin. |
7 | 6 | - `REQUIRED_LS_PROTOCOL_VERSION` in `/io.snyk.eclipse.plugin/src/main/java/io/snyk/languageserver/download/LsBinaries.java`
|
8 | 7 |
|
9 | 8 | **Update Version Numbers**
|
10 | 9 |
|
11 |
| -- Update the release version in all files that specify the Eclipse plugin version. |
12 |
| - |
13 |
| -- Do not change values that do not represent the plugin version. |
| 10 | +- Update the release version in all files that specify the Eclipse plugin version. |
| 11 | + - Do not change values that do not represent the plugin version. |
14 | 12 |
|
15 | 13 |
|
16 | 14 | **Update Changelog**
|
|
19 | 17 | - Make sure Early Access are specified correctly for new feature.
|
20 | 18 |
|
21 | 19 |
|
22 |
| - |
23 | 20 | **Build Artifacts**
|
24 | 21 |
|
25 |
| -- Use `mvnw clean package` or `mvnw clean verify` to build the project and ensure artifacts are created with the correct versions. |
| 22 | +- Use `mvnw clean package` or `mvnw clean verify` to build the project and ensure artifacts are created with the correct versions. |
26 | 23 |
|
27 |
| -- Verify the plugin JAR file in the `target/repository/plugins` folder to confirm the version is correct. |
| 24 | +- Verify the plugin JAR file in the `target/repository/plugins` folder to confirm the version is correct. |
28 | 25 |
|
29 | 26 |
|
30 | 27 | **Testing**
|
31 | 28 |
|
32 |
| -- Ensure all tests for the latest commit have passed before proceeding with the release. |
| 29 | +- Ensure all tests for the latest commit have passed before proceeding with the release. |
33 | 30 |
|
34 | 31 |
|
35 | 32 | **Release via GitHub Actions**
|
36 | 33 |
|
37 | 34 | - If you want to do a hotfix with a subset of commits from main, create a hotfix branch off the previous release tag.
|
38 | 35 | - For the hotfix release, cherry pick the commits you want to go into the hotfix release.
|
39 | 36 |
|
40 |
| -- Trigger the release workflow in GitHub Actions. |
41 |
| - - If this is a hotfix, select the hotfix branch. |
| 37 | +- Trigger the release workflow in GitHub Actions. |
| 38 | + - If this is a hotfix, select the hotfix branch. |
42 | 39 |
|
43 | 40 |
|
44 | 41 | **Release Notes**
|
45 | 42 |
|
46 |
| -- Edit or generate the release notes on GitHub for this release. |
| 43 | +- Edit or generate the release notes on GitHub for this release. |
47 | 44 | - Its okay to include all items from any intermediate hotfix releases in the release notes.
|
48 | 45 |
|
49 | 46 | **Install and Verify Snyk Plugin in Eclipse**
|
50 | 47 |
|
51 |
| -- Open Eclipse, navigate to `Help` → `Eclipse Marketplace`. |
| 48 | +- Open Eclipse, navigate to `Help` → `Eclipse Marketplace`. |
52 | 49 |
|
53 |
| -- Search for "Snyk" and install the latest version of the plugin. |
| 50 | +- Search for "Snyk" and install the latest version of the plugin. |
54 | 51 |
|
55 |
| -- Go to `Eclipse` → `About Eclipse`, click `Installation Details`. |
| 52 | +- Go to `Eclipse` → `About Eclipse`, click `Installation Details`. |
56 | 53 |
|
57 |
| -- Search for "Snyk" and verify that the installed version matches the intended release[6](https://www.clear.rice.edu/comp310/Eclipse/installation.html)[12](https://vaadin.com/docs/v8/framework/installing/installing-eclipse). |
| 54 | +- Search for "Snyk" and verify that the installed version matches the intended release. |
58 | 55 |
|
59 | 56 |
|
60 | 57 | **Verify Snyk CLI**
|
61 | 58 |
|
62 |
| -- Ensure the Snyk CLI is installed, set to the `stable` release channel, and automatic updates are enabled. |
| 59 | +- Ensure the Snyk CLI is installed, set to the `stable` release channel, and automatic updates are enabled. |
63 | 60 |
|
64 |
| -- Execute the CLI binary in the terminal and verify that the version matches the intended release. |
| 61 | +- Execute the CLI binary in the terminal and verify that the version matches the intended release. |
65 | 62 | - The correct version can be found in the `#hammerhead-releases` channel in Slack or in the github cli repo.
|
66 | 63 | https://github.com/snyk/cli/releases
|
67 | 64 |
|
68 | 65 |
|
69 | 66 | **Manual Scan**
|
70 | 67 |
|
71 |
| -- Run a manual scan using the latest version of the Eclipse plugin. |
| 68 | +- Run a manual scan using the latest version of the Eclipse plugin. |
72 | 69 |
|
73 | 70 |
|
74 | 71 | **Publish on Marketplace**
|
75 | 72 |
|
76 |
| - |
77 | 73 | - Login with 1Password
|
78 | 74 |
|
79 | 75 | - Go to Edit: https://marketplace.eclipse.org/content/snyk-security/edit
|
|
0 commit comments