Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 1.51 KB

README.md

File metadata and controls

69 lines (48 loc) · 1.51 KB
Raw

serverless-offline-ses-v2

Serverless plugin to run aws-ses-v2-local

Supports the AWS SES API v1 and v2, and Serverless Framework v2 and v3

Install

npm install --save-dev serverless-offline-ses-v2

Usage

Serverless configuration

Add it to your list of plugins, and optinally custom config

serverless.yaml:

plugins:
  - serverless-offline
  - serverless-offline-ses-v2

custom:
  serverless-offline-ses-v2:
    port: 8005

serverless.js / serverless.ts:

export default {
  plugins: [
    "serverless-offline",
    "serverless-offline-ses-v2",
  ],
  custom: {
    'serverless-offline-ses-v2': {
      port: 8005,
    }
  }
}

Running serverless-offline

Use serverless offline start instead of serverless offline, if you aren't already. This is necessary for serverless-offline to fire off init and end lifecycle hooks so that we can start and stop the aws-ses-v2-local server correctly.

Contributing

Pull requests are welcomed on GitHub! To get started:

  1. Install Git and Node.js
  2. Clone the repository
  3. Install dependencies with npm install
  4. Run npm run test to run tests with Jest
  5. Build with npm run build

Releases

Versions follow the semantic versioning spec.

To release:

  1. Use npm version <major | minor | patch> to bump the version
  2. Run git push --follow-tags to push with tags
  3. Wait for GitHub Actions to publish to the NPM registry.