Skip to content

Commit

Permalink
Publishing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
d-gubert committed Mar 7, 2024
1 parent da5bd71 commit 414edb9
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,19 @@ 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](https://github.com/RocketChat/Rocket.Chat.Apps-engine/pull/307).

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](https://semver.org/) using `npm version [major|minor|patch]`.

To publish a new version, run the following command:

```sh
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).

0 comments on commit 414edb9

Please sign in to comment.