https://github.com/lannonbr/vsce-action

A GitHub Action to automate deploying VS Code extensions
https://github.com/lannonbr/vsce-action

github-actions vscode

Last synced: 12 days ago
JSON representation

A GitHub Action to automate deploying VS Code extensions

• Host: GitHub
• URL: https://github.com/lannonbr/vsce-action
• Owner: lannonbr
• License: mit
• Created: 2018-11-24T03:20:05.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-21T12:52:41.000Z (3 months ago)
• Last Synced: 2024-10-15T20:01:50.093Z (24 days ago)
• Topics: github-actions, vscode
• Language: Dockerfile
• Size: 11.7 KB
• Stars: 88
• Watchers: 3
• Forks: 14
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-actions - Deploy VS Code extensions with vsce
• fucking-awesome-actions - Deploy VS Code extensions with vsce
• awesome-workflows - Deploy VS Code extensions with vsce

README

        
# VS Code VSCE GitHub Action

A [GitHub Action](https://github.com/features/actions) to automate deploying VS Code extensions by using [vsce](https://github.com/Microsoft/vscode-vsce).

It will enable workflows to easily deploy your VS Code extensions to the marketplace.

# Usage

Here's an example workflow which publishes an extension when you push to the master branch.

```yaml

on:

  push:

    branches:

      - master

name: Deploy Extension

jobs:

  deploy:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - run: npm install

      - uses: lannonbr/[email protected]

        with:

          args: "publish -p $VSCE_TOKEN"

        env:

          VSCE_TOKEN: ${{ secrets.VSCE_TOKEN }}

```

# Secrets

The `VSCE_TOKEN` secret is used to authenticate with Azure DevOps when running the `vsce` CLI. You can find out how to create this token here on the VS Code Docs: [Publishing VS Code Extensions](https://code.visualstudio.com/docs/extensions/publish-extension)

# Example Use Cases

- Deploy nightly builds once a day if the `master` branch has changed since the last build.

- Deploy releases after PRs with a `Release` label are merged into Master.

- Promote new version of extension on social media with additional Actions.

Creating and publishing extensions with `vsce` is already fairly simple, but this will further integrate it into CI workflows with GitHub Actions.