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.
- Concurrent compilation happens across all CPU cores.
- Support for both
serverless deploy
andserverless deploy function
commands. - Support for
serverless invoke local
command.
-
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 path or a package path. E.g.functions: example: runtime: go1.x handler: functions/example/main.go # or just functions/example
Default values:
custom:
go:
baseDir: . # folder where go.mod file lives, if set `handler` property should be set relatively to that folder
binDir: .bin # target folder for binary files
cmd: GOOS=linux go build -ldflags="-s -w"' # compile command
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 a function only if runtime
(either on function or provider level) is set to Go (go1.x
).
For every matched function it also overrides package
parameter to
individually: true
exclude:
- `./**`
include:
- `<path to the compiled file and any files that you defined to be included>`