Skip to content

PIPELINES-GO.md

Latest commit

 

History

History
172 lines (140 loc) · 5.22 KB

PIPELINES-GO.md

File metadata and controls

172 lines (140 loc) · 5.22 KB
Raw

Built-in go Pipelines

Melange includes built-in pipelines to compile go projects. The first one, go/build gives authors more control on the compiler invocation while go/install focuses on simplicity.

To get started quickly, we offer two working examples: go-build.yaml and go-install.yaml

Simple and quick builds with go/install

For projects not needing sophisticated interactions with go build or control over how source is downloaded, go/install provides a quick and simple way to compile any publicly available go project.

Internally go/install is an interface to the go install command. It will download the source code and dependencies and build them. Any produced binaries will be installed into the specified directory.

Here's a sample of a one-shot compilation of an example project:

package:
  name: hello
  version: v0.0.1
  epoch: 0
  description: "A project that will greet the world infinitely"
environment:
  contents:
    keyring:
      - https://packages.wolfi.dev/os/wolfi-signing.rsa.pub
    repositories:
      - https://packages.wolfi.dev/os
pipeline:
  - uses: go/install
    with:
      package: github.com/puerco/hello
      version: HEAD

(:bulb: Experiment with this code, download it from the examples directory)

Building golang projects with go/build

The go/build pipeline is a declarative interface to the go build command. This pipeline executes go build on already installed or cloned go projects. It can compile more than one package and the collection and installation of built artifacts is manual.

Here's a sample melange configuration file cloning and running the same sample project as above:

package:
  name: hello
  version: v0.0.1
  epoch: 0
  description: "A project that will greet the world infinitely"
environment:
  contents:
    keyring:
      - https://packages.wolfi.dev/os/wolfi-signing.rsa.pub
    repositories:
      - https://packages.wolfi.dev/os
pipeline:
  - uses: git-checkout
    with:
      repository: https://github.com/uservers/miniprow.git
      destination: build-dir
  - run: |
      git checkout ${{package.version}}
  - uses: go/build
    with:
      modroot: build-dir
      tags: enterprise
      packages: main.go
      output: hello

(:bulb: Experiment with this code, download it from the examples directory)

Build Parameters

Both go/install and go/build support passing a few parameters to the go compiler by setting them in the melange configuration file. As of this writing, you can define the following values:

  tags:
    description: |
      A comma-separated list of build tags to pass to the go compiler

  ldflags:
    description:
      List of [pattern=]arg to pass to the go compiler with -ldflags

  deps:
    description: |
      space separated list of go modules to update before building. example: github.com/foo/bar@v1.2.3

Updating dependencies with go/bump

The go/bump pipeline is a declarative interface to the GoBump package. GoBump is a simple command-line tool written in Go that allows you to update the versions of your Go dependencies.

Here's a sample melange configuration file cloning and running the same sample project as above:

package:
  name: hello
  version: 0.0.1
  epoch: 0
  description: "A project that will greet the world infinitely"

environment:
  contents:
    keyring:
      - https://packages.wolfi.dev/os/wolfi-signing.rsa.pub
    repositories:
      - https://packages.wolfi.dev/os

pipeline:
  - uses: git-checkout
    with:
      repository: https://github.com/puerco/hello.git
      expected-commit: a73c4feb284dc6ed1e5758740f717f99dcd4c9d7
      tag: v${{package.version}}

  - uses: go/bump
    with:
      deps: github.com/sirupsen/logrus@v1.9.3

  - uses: go/build
    with:
      tags: enterprise
      packages: .
      output: hello

(:bulb: Experiment with this code, download it from the examples directory)

Using go workspace mode

The go/bump pipeline also supports Go workspace mode through the work parameter. When enabled, it will use go work vendor instead of go mod vendor for dependency management. This is useful for projects that use Go workspaces (go.work files).

Example usage with workspace mode:

  - uses: go/bump
    with:
      deps: github.com/sirupsen/logrus@v1.9.3
      work: true

For the most up to date supported features check the build, install, and bump, pipeline definitions. Feel free to request more features in the built-in pipelines by filing a new issue in the melange repository!