Go Generate

Integrate SOM code generation into your Go build process using go:generate.

Setup

Add a generate directive to a file in your project (commonly generate.go or in your model package):

//go:generate go run github.com/go-surreal/som@latest -i ./model

package main

Running Generation

Execute all generate directives in your project:

go generate ./...

Or run from a specific directory:

go generate ./model/...

Placement Options

In root directory

Create a generate.go file:

//go:generate go run github.com/go-surreal/som@latest -i ./model

package main

In model package

Add the directive to any .go file in your model directory:

//go:generate go run github.com/go-surreal/som@latest -i .

package model

CI/CD Integration

Add generation to your CI pipeline to verify generated code is up to date:

# .github/workflows/ci.yml
steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-go@v5
    with:
      go-version: '1.25'
  - run: go generate ./...
  - run: git diff --exit-code  # Fail if generated code differs

Custom Output Directory

Specify a custom output directory with -o:

//go:generate go run github.com/go-surreal/som@latest -i ./model -o ./db/generated

package main