Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test pre-release extensions as an Extension author #138068

Closed
3 tasks done
sandy081 opened this issue Nov 29, 2021 · 7 comments
Closed
3 tasks done

Test pre-release extensions as an Extension author #138068

sandy081 opened this issue Nov 29, 2021 · 7 comments

Comments

@sandy081
Copy link
Member

sandy081 commented Nov 29, 2021

Ref #15756

Complexity: 5

Create Issue


As an extension author you can support pre releases for your extension.

Extension authoring guide

Please read following before starting testing

Note 1: You can only use major.minor.patch for extension version. pre-release tags are not supported.
Note 2: Recommended to use major.EVEN_NUMBER.patch for release versions and major.ODD_NUMBER.patch for pre-release versions. Eg: 0.2.* for release and 0.3.* for pre-release.
Note 3: Please wait at least for ~10 minutes after publishing your extension for VS Code to pick it.
Note 4: Pre-release versions are given preference only if they are newer than the newest released version. So, please make sure to have a pre-release version newer than newest released version for testing pre-release versions.

Please test following:

  • Using latest vsce you can publish a pre-release version using --pre-release flag. Eg: vsce publish --pre-release

  • Pre-release extension version is supported only when vscode.engine value in package.json is >= 1.63.0.

  • Publish some release versions and some pre-release versions.

  • Open VS Code insiders and browse for your extension

    • Test the representation of your extension in extension view, hover and extension editor. Pre-release bookmark, badge & indicator are used to represent that extension has a pre-release or is pre-release.
    • Test that the primary action to install your extension is to install the pre-release and the secondary action is to install the release version. Test these actions are working as expected.
  • Test Updating

    • Publish a newer version of release/pre-release version of your extension
    • If you had installed pre-release version before, VS Code updates to the newest version (can be release/pre-release)
    • If you had installed release version, VS Code updates to the newest release version.
  • Make sure that pre-release versions cannot be installed in current VS Code stable

@sandy081 sandy081 added this to the November 2021 milestone Nov 29, 2021
@sandy081 sandy081 changed the title Test pre-release extensions Test pre-release extensions as an Extension author Nov 29, 2021
@isidorn
Copy link
Contributor

isidorn commented Nov 30, 2021

@JacksonKearl @alexdima @roblourens if you have any questions or if something is not clear from the test plan item please reach out to me. Thanks.

@JacksonKearl
Copy link
Contributor

The linked Extension Authoring Guide doesn't seem to include information on pre-release publishing, is that documented somewhere?

@roblourens
Copy link
Member

Awesome, can't wait to adopt it for SSH

@sandy081
Copy link
Member Author

sandy081 commented Dec 1, 2021

@JacksonKearl Documentation of the feature is pending yet, we will add all information once testing is done. Thanks for reminding

@chrmarti chrmarti assigned weinand and unassigned alexdima Dec 1, 2021
@weinand
Copy link
Contributor

weinand commented Dec 1, 2021

Very cool feature!

Now we can support a pre-release version of Mock Debug (which uses a pre-release version of the Debug Adapter Protocol):

image

@isidorn
Copy link
Contributor

isidorn commented Dec 1, 2021

Great use case!

@isidorn
Copy link
Contributor

isidorn commented Dec 1, 2021

I wrote a first version of the docs for extension authors
https://github.com/microsoft/vscode-docs/blob/vnext/api/working-with-extensions/publishing-extension.md#pre-release-extensions
Feedback welcome. Especially interested in parts that might have been confusing for extension authors.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

6 participants