README

⚡️Serverless Framework Go Plugin

serverless-golang 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 2.72.2 and above.

dev.to: A better way of deploying Go services with Serverless Framework

output

Features

Concurrent compilation happens across all CPU cores.
Support for both serverless deploy and serverless deploy function commands.
Support for serverless invoke local command.
Additional command serverless go build, support build only 1 function with parameter --f .
Support ARM64 architecture with Amazon Linux 2 (provided.al2) runtime

Install

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

Replace every Go function's handler with *.go file path or a package path. E.g.

functions:
  example:
    runtime: go1.x # or provided.al2
    architecture: x86_64 # or arm64
    handler: functions/example/main.go # or just functions/example

Configuration

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
    cgo: 0 # CGO_ENABLED flag
    cmd: GOOS=linux go build -ldflags="-s -w"' # compile command
    monorepo: false # if enabled, builds function every directory (useful for monorepo where go.mod is managed by each function)

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 a function only if runtime (either on function or provider level) is set to Go (go1.x) or Amazon Linux 2 (provided.al2)

For every matched function it also overrides package parameter to

For Go (go1.x) runtime

individually: true
excludeDevDependencies: false
patterns: 
   - "!./**"
   - `<path to the compiled file and any files that you defined to be included>`

For Amazon Linux 2 (provided.al2) runtime

individually: true
excludeDevDependencies: false
artifact: `<path to the compiled & zipped file>`

Usage no npm install needed!