Skip to content

RocketChat/Rocket.Chat.Apps-compiler

Repository files navigation

Rocket.Chat.Apps-compiler

The one Compiler to rule them all.

This library provides the core Rocket.Chat App compilation feature for any other tool in the Rocket.Chat ecosystem. It has been extracted from the Apps-Engine so the compilation isn't done during runtime, and for us to support pre-compiled app packages. This has a bunch of benefits as stated here.

This library exports an AppsCompiler class that handles compilation from file system path, and outputs a zip to the file system.

Publishing to NPM

This package is published to NPM using the @rocket.chat scope. To publish a new version, you need to have access to the @rocket.chat scope on NPM. If you don't have access, ask someone who does to add you to the scope.

Before publishing, make sure you've bumped the package version according to Semantic Versioning using npm version [major|minor|patch].

To publish a new version, run the following command:

npm run release

Check package.json for details on the commands it runs.

After publishing, make sure to create a new tag for the release in the Github repository (make sure to push the bump commit before you do so).