Skip to content

Commit 3cffdff

Browse files
authored
docs: format RELEASE.md [IDE-1224] (#296)
1 parent 6aeaac1 commit 3cffdff

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

RELEASE.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
21
## Eclipse Plugin Release Steps
32

43
**Protocol Version Verification**
54

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.
76
- `REQUIRED_LS_PROTOCOL_VERSION` in `/io.snyk.eclipse.plugin/src/main/java/io/snyk/languageserver/download/LsBinaries.java`
87

98
**Update Version Numbers**
109

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.
1412

1513

1614
**Update Changelog**
@@ -19,61 +17,59 @@
1917
- Make sure Early Access are specified correctly for new feature.
2018

2119

22-
2320
**Build Artifacts**
2421

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.
2623

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.
2825

2926

3027
**Testing**
3128

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.
3330

3431

3532
**Release via GitHub Actions**
3633

3734
- If you want to do a hotfix with a subset of commits from main, create a hotfix branch off the previous release tag.
3835
- For the hotfix release, cherry pick the commits you want to go into the hotfix release.
3936

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.
4239

4340

4441
**Release Notes**
4542

46-
- Edit or generate the release notes on GitHub for this release.
43+
- Edit or generate the release notes on GitHub for this release.
4744
- Its okay to include all items from any intermediate hotfix releases in the release notes.
4845

4946
**Install and Verify Snyk Plugin in Eclipse**
5047

51-
- Open Eclipse, navigate to `Help``Eclipse Marketplace`.
48+
- Open Eclipse, navigate to `Help``Eclipse Marketplace`.
5249

53-
- Search for "Snyk" and install the latest version of the plugin.
50+
- Search for "Snyk" and install the latest version of the plugin.
5451

55-
- Go to `Eclipse``About Eclipse`, click `Installation Details`.
52+
- Go to `Eclipse``About Eclipse`, click `Installation Details`.
5653

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.
5855

5956

6057
**Verify Snyk CLI**
6158

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.
6360

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.
6562
- The correct version can be found in the `#hammerhead-releases` channel in Slack or in the github cli repo.
6663
https://github.com/snyk/cli/releases
6764

6865

6966
**Manual Scan**
7067

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.
7269

7370

7471
**Publish on Marketplace**
7572

76-
7773
- Login with 1Password
7874

7975
- Go to Edit: https://marketplace.eclipse.org/content/snyk-security/edit

0 commit comments

Comments
 (0)