serverless-offline-msk
Version:
A serverless offline plugin that enables AWS MSK events
47 lines (32 loc) • 1.48 kB
Markdown
# Serverless Framework Dashboard Plugin
[](https://github.com/serverless/dashboard-plugin/actions?query=workflow%3AIntegrate)
[](https://badge.fury.io/js/@serverless/dashboard-plugin)
[](https://codecov.io/gh/serverless/dashboard-plugin)
To enable the various features of the [Serverless Framework Dashboard](https://app.serverless.com) for a particular Service you must deploy or redeploy that Service, using Serverless Framework open-source CLI version 1.45.1 or later.
Upon deployment, the Serverless Framwork Enteprise Plugin will automatically wrap and instrument your functions to work with the Serverless Framework Dashboard dashboard.
## Dev notes
### Install dependencies and build SDK JS
```
npm i
cd sdk-js
npm i
npm run build
cd -
```
### Test
```
npm t
cd sdk-js
npm t
cd -
```
#### Integration tests
For integration tests run you need an access to `integration` dashboard organization, and generated for it access key.
Then tests can be run as:
```
SERVERLESS_ACCESS_KEY=xxx npm run integration-test
```
### Release process
- Create a PR updating version in `package.json`
- Create a draft release on github with a change log
- Have it approved & merge (Release is automatically published via CI)