Skip to content

Commit

Permalink
Merge pull request #5 from claui/publish
Browse files Browse the repository at this point in the history
Prepare for publishing
  • Loading branch information
claui committed May 5, 2022
2 parents e2803e2 + 416eb06 commit d4a61e3
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,21 @@ To build the extension, run: `yarn package`
Unlike `vsce package`, running `yarn package` will work around issue 517.
Use `yarn package` as long as the issue is unresolved.

## Publishing the extension

To publish to the VS Code Extension Marketplace, first choose a target version.
[The VS Code folks recommend](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#prerelease-extensions) the following numbering scheme:

- `major.ODD_NUMBER.patch` (e.g. 1.1.0) for **pre-release** versions; and
- `major.EVEN_NUMBER.patch` (e.g. 1.2.0) for **release** versions.

After deciding on a target version, run:

- `yarn login`
- `yarn publish [version]`

The `yarn publish` command first updates the version number in [extension/package.json](./extension/package.json) to the given version. Then it packages and publishes the extension to the VS Code Extension Marketplace.

## License

This source code repository contains code and assets sourced from different parties. Therefore, multiple sets of license terms apply to different parts of this source code repository.
Expand Down
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
"packageManager": "yarn@3.2.0",
"scripts": {
"compile": "tsc -p extension/",
"login": "vsce login claui",
"package": "cd extension && vsce package --no-dependencies --pre-release --yarn --githubBranch main/extension",
"publish": "cd extension && vsce publish --no-dependencies --pre-release --yarn --githubBranch main/extension",
"vscode:prepublish": "yarn compile"
}
}

0 comments on commit d4a61e3

Please sign in to comment.