Skip to content

Commit 0bf6dea

Browse files
Update CONTRIBUTING.md with info about automatic releases
1 parent a8294ab commit 0bf6dea

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,17 @@ We're happy to gather more resources over time here, including more in-depth get
182182

183183
1. Bump the version properly in `package.json` and `server/package.json` and their lockfiles. Commit and push the version bump.
184184
2. Make sure @ryyppy is aware of your changes. He needs to sync them over to the vim plugin.
185-
3. Let CI build your version bump commit. Download the autogenerated `.vsix` from that CI run, unzip it, and rename it to `rescript-vscode-<version-number>.vsix` (`rescript-vscode-1.3.0.vsix` for example).
186-
4. Go to the appropriate [VSCode Marketplace Publisher](https://marketplace.visualstudio.com/manage/publishers/chenglou92), select the three dots next to the extension name, and choose `Update`. Upload your `.vsix` there.
187-
5. Not done! Make a new manual release [here](https://github.com/rescript-lang/rescript-vscode/releases), and make sure you attach the generated `.vsix` onto that new release as well. This is for folks who don't use the VSCode marketplace.
185+
3. Let CI build your version bump commit.
186+
4. Tag the commit with the version number (e.g. `git tag 1.6.0`) and push the tag (e.g. `git push origin 1.6.0`). Another build will trigger, which should automatically:
187+
188+
- create a `rescript-vscode-<version-number>.vsix` file
189+
- publish that extension version to the VSCode marketplace
190+
- create an automatic release on GitHub
191+
192+
If that somehow does not work, you can do the above steps manually:
193+
194+
1. Download the autogenerated `.vsix` from the previous successful CI run, unzip it, and rename it to `rescript-vscode-<version-number>.vsix` (`rescript-vscode-1.3.0.vsix` for example).
195+
2. Go to the appropriate [VSCode Marketplace Publisher](https://marketplace.visualstudio.com/manage/publishers/chenglou92), select the three dots next to the extension name, and choose `Update`. Upload your `.vsix` there.
196+
3. Not done! Make a new manual release [here](https://github.com/rescript-lang/rescript-vscode/releases), and make sure you attach the generated `.vsix` onto that new release as well. This is for folks who don't use the VSCode marketplace.
188197

189198
For beta releases, ask folks to try the `.vsix` from CI directly.

0 commit comments

Comments
 (0)