{"id":13533691,"url":"https://github.com/HaaLeo/publish-vscode-extension","last_synced_at":"2025-04-01T22:30:32.178Z","repository":{"id":37740649,"uuid":"273933544","full_name":"HaaLeo/publish-vscode-extension","owner":"HaaLeo","description":"GitHub action to publish your VS Code Extension to the Open VSX Registry or Visual Studio Marketplace.","archived":false,"fork":false,"pushed_at":"2024-04-04T17:12:12.000Z","size":6810,"stargazers_count":192,"open_issues_count":4,"forks_count":13,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-01T17:23:47.828Z","etag":null,"topics":["deployment","github-actions","open-vsx","openvsx","publishing","visual-studio-code-extension","visual-studio-marketplace","vscode"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HaaLeo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"HaaLeo","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://www.paypal.me/LeoHanisch"]}},"created_at":"2020-06-21T15:37:39.000Z","updated_at":"2024-05-12T06:33:06.842Z","dependencies_parsed_at":"2023-02-13T19:01:12.869Z","dependency_job_id":"0c2f37d4-39a2-4914-a2bf-90d85a77823e","html_url":"https://github.com/HaaLeo/publish-vscode-extension","commit_stats":{"total_commits":110,"total_committers":5,"mean_commits":22.0,"dds":0.4727272727272728,"last_synced_commit":"c1a0486c5a3eed24e8c21d4e37889a7c4c60c443"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaaLeo%2Fpublish-vscode-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaaLeo%2Fpublish-vscode-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaaLeo%2Fpublish-vscode-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaaLeo%2Fpublish-vscode-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HaaLeo","download_url":"https://codeload.github.com/HaaLeo/publish-vscode-extension/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222774628,"owners_count":17035752,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deployment","github-actions","open-vsx","openvsx","publishing","visual-studio-code-extension","visual-studio-marketplace","vscode"],"created_at":"2024-08-01T07:01:22.216Z","updated_at":"2025-04-01T22:30:32.170Z","avatar_url":"https://github.com/HaaLeo.png","language":"TypeScript","funding_links":["https://github.com/sponsors/HaaLeo","https://www.paypal.me/LeoHanisch","https://www.paypal.me/LeoHanisch/3eur"],"categories":["Community Resources","TypeScript","deployment","publishing"],"sub_categories":["Deployment"],"readme":"# Publish VS Code Extension \u0026#8212; GitHub Action\n\n[![Build, Lint, Test and Deploy](https://img.shields.io/github/actions/workflow/status/HaaLeo/publish-vscode-extension/CI.yml?style=flat-square\u0026label=Lint%2C%20Build%2C%20Test%20and%20Deploy)](https://github.com/HaaLeo/publish-vscode-extension/actions?query=workflow%3A%22Build%2C+Lint%2C+Test+and+Deploy%22) [![Coverage Status](https://img.shields.io/coveralls/github/HaaLeo/publish-vscode-extension?style=flat-square)](https://coveralls.io/github/HaaLeo/publish-vscode-extension)  \n[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://raw.githubusercontent.com/HaaLeo/publish-vscode-extension/master/LICENSE.txt) [![Stars](https://img.shields.io/github/stars/HaaLeo/publish-vscode-extension.svg?label=Stars\u0026logo=github\u0026style=flat-square)](https://github.com/HaaLeo/publish-vscode-extension/stargazers)  \n[![Donate](https://img.shields.io/badge/☕️-Buy%20Me%20a%20Coffee-blue.svg?\u0026style=flat-square)](https://www.paypal.me/LeoHanisch/3eur)\n\nGitHub action to publish your VS Code Extension to the [Open VSX Registry](https://open-vsx.org/) or the [Visual Studio Marketplace](https://marketplace.visualstudio.com).\n\n\u003e All breaking changes of **v2** are listed in the [changelog](CHANGELOG.md#changelog)\n\n## Usage\n\nTo use the GitHub Action, just [reference the action](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#referencing-actions-in-your-workflow) in your workflow file.\n\n### Example\n\nThe following example shows a workflow that publishes an extension to the Open VSX Registry as well as to the Visual Studio Marketplace when a new tag was created:\n\n```yaml\non:\n  push:\n    tags:\n      - \"*\"\n\nname: Deploy Extension\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - uses: actions/setup-node@v4\n        with:\n          node-version: 20\n      - run: npm ci\n      - name: Publish to Open VSX Registry\n        uses: HaaLeo/publish-vscode-extension@v2\n        with:\n          pat: ${{ secrets.OPEN_VSX_TOKEN }}\n      - name: Publish to Visual Studio Marketplace\n        uses: HaaLeo/publish-vscode-extension@v2\n        with:\n          pat: ${{ secrets.VS_MARKETPLACE_TOKEN }}\n          registryUrl: https://marketplace.visualstudio.com\n```\n\nTo package the extension only once and publish the **identical** `.vsix` file to both registries one can use the following two steps instead:\n\n```yaml\n- name: Publish to Open VSX Registry\n  uses: HaaLeo/publish-vscode-extension@v2\n  id: publishToOpenVSX\n  with:\n    pat: ${{ secrets.OPEN_VSX_TOKEN }}\n- name: Publish to Visual Studio Marketplace\n  uses: HaaLeo/publish-vscode-extension@v2\n  with:\n    pat: ${{ secrets.VS_MARKETPLACE_TOKEN }}\n    registryUrl: https://marketplace.visualstudio.com\n    extensionFile: ${{ steps.publishToOpenVSX.outputs.vsixPath }}\n```\n\nFor a more complete and complex example one can check out the workflow of [`HaaLeo/vscode-timing`](https://github.com/HaaLeo/vscode-timing/blob/master/.github/workflows/cicd.yml#L1).\n\n### Open VSX Registry\n\nTo publish to the Open VSX Registry ensure that your [extension's namespace](https://github.com/eclipse/openvsx/wiki/Publishing-Extensions#2-create-the-namespace) was created **beforehand**.\nYou need to set the `pat` parameter to your [Open VSX access token](https://github.com/eclipse/openvsx/wiki/Publishing-Extensions#1-create-an-access-token).\nFurther, you should ensure that you only publish an extension which is licensed.\nFor more information regarding Open VSX' timeline and its extensions' licensing check out [Brian King's blog](https://blogs.eclipse.org/post/brian-king/open-vsx-registry-under-new-management) (section \"Licensing\" and \"Timeline\").\n\nCurrently, this GitHub action allows you to publish extensions which do not state their license terms.\nHowever, this behavior is deprecated and a future release of this action will reject unlicensed extensions.\nTherefore, I heavily encourage you to publish an extension with a (permissive) license such as the [MIT license](https://choosealicense.com/licenses/mit/).\n\n### Visual Studio Marketplace\n\nIn order to upload your extension to the VS Marketplace you need to set the `pat` option to the corresponding [access token](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#get-a-personal-access-token). \nFurther, the `registryUrl` must be set to `https://marketplace.visualstudio.com`.\n\n\n## Input Parameters\n\nYou can set any or all of the following input parameters:\n\n|Name |Type |Required? |Default |Description\n|-|-|-|-|-\n|`pat` |string  |yes |-|The personal access token to the corresponding registry.\n|`extensionFile` |string  |no | - |Path to the vsix file to be published. This option will be preferred when set together with `packagePath`.\n|`registryUrl` |string  |no |`https://open-vsx.org` |Use the registry API at this base URL\n|`packagePath` |string |no | `./` |Path to the extension to be packaged and published. When `extensionFile` is set too `packagePath` is ignored.\n|`baseContentUrl` |string |no | - | Prepend all relative links in README.md with this URL.\n|`baseImagesUrl` |string |no | - | Prepend all relative image links in README.md with this URL.\n|`yarn` |boolean |no | `false` | Use yarn instead of npm while packing extension files.\n|`dryRun` |boolean |no | `false` | Set this option to `true` to package your extension but do not publish it. When using this option set the `pat` option to a stub value.\n|`noVerify` |boolean| no |`false` | Allow publishing extensions to the visual studio marketplace which use a proposed API (enableProposedApi: true). Similar to vsce's `--noVerify` command line argument.\n|`preRelease` |boolean| no |`false` | Mark the extensions release as pre-release. Is only considered when packaging an extension.\n|`dependencies` |boolean| no |`true` | Check that dependencies defined in `package.json` exist in `node_modules`. Set to `false` if using pnpm or yarn v2+ with PnP.\n|`skipDuplicate` |boolean| no |`false` | Fail silently if version already exists on the marketplace. Equivalent to the `--skip-duplicate` option of the vsce CLI.\n|`target` |string| no | - | Target architecture(s) the extension should run on. Separate multiple targets with spaces. E.g.: `'win32-x64 linux-x64'`\n\n## Outputs\n\nThe action exposes the following outputs:\n\n|Name |Type |Description\n|-|-|-\n|`vsixPath` |string |The path to the packaged and published VSIX file.\n\n## Contribution\n\nIf you found a bug or are missing a feature do not hesitate to [file an issue](https://github.com/HaaLeo/publish-vscode-extension/issues/new/choose).  \nPull Requests are welcome!\nTo get started submitting code changes please take a look at the [CONTRIBUTING.md](./CONTRIBUTING.md) file first.\n\n## Support\n\nWhen you like this extension make sure to [star the repo](https://github.com/HaaLeo/publish-vscode-extension/stargazers). I am always looking for new ideas and feedback.  \nIn addition, it is possible to [donate via paypal](https://www.paypal.me/LeoHanisch/3eur).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHaaLeo%2Fpublish-vscode-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FHaaLeo%2Fpublish-vscode-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHaaLeo%2Fpublish-vscode-extension/lists"}