Package Exports

serverless-go-plugin

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (serverless-go-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

⚡️Serverless Framework Go Plugin

serverless-go-plugin is a Serverless Framework plugin that compiles Go functions on the fly. You don't need to do it manually before serverless deploy. Once the plugin is installed it will happen automatically. The plugin works with Serverless Framework version 1.52 and above.

Features:

Concurrent compilation happen across all CPU cores.
Support for both serverless deploy and serverless deploy function commands.
Support for serverless invoke local command.

Install

Install the plugin
```
npm i --save-dev serverless-go-plugin
```
Add it to your serverless.yaml
```
plugins:
  - serverless-go-plugin
```

Replace every Go function's handler with *.go file paths. E.g.

functions:
  example:
    handler: functions/example/main.go

Configuration

Default values:

custom:
  go:
    baseDir: . # folder where go.mod file lives
    binDir: .bin # target folder for binary files
    cmd: GOOS=linux go build -ldflags="-s -w"' # compile command

How does it work?

The plugin compiles every Go function defined in serverless.yaml into .bin directory. After that it internally changes handler so that the Serverless Framework will deploy the compiled file not the source file. The plugin compiles functions only if handler property points to *.go file.

For every matched function it also sets package parameter to

individually: true
exclude:
  - `./**`
include:
  - `<path to the compiled file>`

It will happen only if package is not defined for a function.