Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (32 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

52 lines (32 loc) · 1.7 KB

Contributing

Installation

npm install

Configuration

The repository comes with an .env.local file configured to work locally.

Feel free to check it out, and make a copy to .env in order to customize.

cp .env.local .env

Generating the VSIX File

A VSIX file is a packaged extension for Visual Studio Code. It contains all the files and metadata needed to install and run the extension.

The VSIX file is need to install the extension manually or distribute it to others.

To update the extension after making code changes, you need to regenerate the VSIX file. Run the following command in your project directory:

npx vsce package

This will build a new .vsix file in the directory (localstack-x.x.1.vsix).

While installing from a VSIX file is common for local development or sharing, you can also run and test the extension directly in VSCode without packaging it. To do this, open the extension project in VSCode and press F5 to launch a new Extension Development Host window.

Installing the VSIX File

To install the generated VSIX file in Visual Studio Code:

  1. Open the Extensions view (Cmd+Shift+X on macOS, Ctrl+Shift+X on Windows/Linux) in VSCode.
  2. Click the three-dot menu in the top right.
  3. Select Install from VSIX....
  4. Choose the .vsix file.

Releasing and publishing

Releasing and publishing is controlled by workflows.

The release workflow will run once a day, bump the version automatically and push the corresponding git version tag. If necessary, it can be triggered manually.

The publish workflow will run for every git version tag, and will generate a GitHub release and publish the extension to the VS Marketplace and the Open VSX Registry.