Skip to content

Commit a1a6b0f

Browse files
add documentation for installing pre-release versions on the marketplace (#1467)
1 parent 82fb69c commit a1a6b0f

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ When you first open the project in VS Code you will be recommended to also insta
3232

3333
To run your version of the Swift extension while in VS Code, press `F5`. This will open up another instance of VS Code with it running. You can use the original version of VS Code to debug it.
3434

35-
### Installing a pre-released version
35+
### Installing Pre-Release Builds
3636

3737
If you'd like to try out a change during your day to day work that has not yet been released to the VS Code Marketplace you can build and install your own `.vsix` package from this repository.
3838

@@ -54,6 +54,18 @@ Alternatively you can install the extension from the Extensions panel by clickin
5454

5555
If you'd like to return to using the released version of the extension you can uninstall then reinstall Swift for VS Code from the Extensions panel.
5656

57+
#### Pre-Release Builds on the Marketplace
58+
59+
Occasionally, pre-release builds will be published to the VS Code Marketplace. You can switch to the pre-release version by clicking on the `Switch to Pre-Release Version` button in the Extensions View:
60+
61+
![](docs/images/install-pre-release.png)
62+
63+
Switching back to the release version can be done by clicking on the `Switch to Release Version` button.
64+
65+
Release builds for the extension will always have an even minor version number (e.g. `2.0.2`). Pre-release versions will always be one minor version above the latest release version with a patch version set to the day that the VSIX was built (e.g. `2.1.20250327`). These rules are enforced by CI.
66+
67+
The version number in the [package.json](package.json) should always match the most recently published build on the VS Code Marketplace.
68+
5769
## Submitting a bug or issue
5870

5971
Please ensure to include the following in your bug report:

docs/images/install-pre-release.png

754 KB
Loading

0 commit comments

Comments
 (0)