go-install action

Install a go package at the requested version.

• Usage
• Community
  • Code of Conduct
  • Communication
  • Contributing
• License

Usage

See action.yml

- uses: reconcilerio/go-install-action@v1
  with:
    # Optional package.
    # The go package to install. Exactly one of 'package' or 'tool' is required.
    # Default: ''
    package: ''
    # Optional version.
    # The go module's version to install. Only valid with 'package'.
    # Default: none
    version: ''
    # Optional tool.
    # The go tool defined in go.mod to install. Exactly one of 'package' or 'tool' is required.
    # Default: none
    tool: ''
    # Optional working-directory.
    # directory containing a go.mod file defining the package's version
    # Default: ''
    working-directory: ''
    # Optional toolchain.
    # The go toolchain to use.
    # Default: `${GOTOOLCHAIN}`
    toolchain: ''
    # Optional download-url-template
    # URL template to resolve a pre-built binary. If the expanded URL resolves to an artifact, no artifact will be built or cached.
    download-url-template: ''
    # Optional download-path-within-archive
    # Path within an archive resolved by download-url-template.
    download-path-within-archive: ''
    # Optional output.
    # Name of the built binary.
    # Default: none
    output: ''
    # Optional output-dir.
    # Directory to place the built binary. Defaults to `${GOBIN}` or `${GOPATH}/bin`.
    # Default: none
    output-dir: ''
    # Optional output-path-env.
    # Environment variable to set the output path to.
    # Default: none
    output-path-env: ''
    # Optional cache-enabled.
    # Cache built artifacts. If false, always build from source.
    # Default: 'true'
    cache-enabled: ''

When building from source, an appropriate go toolchain is required. If unsure, favor a more recent toolchain version.

Basic:

steps:
- uses: reconcilerio/go-install-action@v1
  with:
    package: github.com/google/go-containerregistry/cmd/crane
    output-dir: /usr/local/bin
- run: crane ls ubuntu

The module version is resolved from go.mod, if available, defaulting to latest.

Pre-built:

steps:
- uses: reconcilerio/go-install-action@v1
  with:
  package: sigs.k8s.io/kustomize/kustomize/v5
  download-url-template: https://github.com/kubernetes-sigs/kustomize/releases/download/kustomize%2F${version}/kustomize_${version}_${os}_${arch}.tar.gz
  download-path-within-archive: kustomize
- run: kustomize --help

The download-url-template input defines a templated evaluated in a bash shell producing a URL containing the binary to install. If the URL resolves, it is installed. If the URL does not resolve to the binary, it falls back to building from source.

Available variables:

• version - normalized version for the go package
• os - value returned for the current environment from go env GOOS.
• arch - value returned for the current environment from go env GOARCH.
• any other variable in the current environment

URLs that resolve to an archive can specify the path within the archive to the binary with download-path-within-archive, which is also evaluated as a bash template. Currently, only tar archives are supported.

Artifacts resolved from a URL skip participation with the caches, and build specific inputs.

Tool:

steps:
- uses: reconcilerio/go-install-action@v1
  with:
    tool: crane
    output-dir: /usr/local/bin
- run: crane ls ubuntu

Tool usage requires the tool to be defined in go.mod:

tool github.com/google/go-containerregistry/cmd/crane

...

require github.com/google/go-containerregistry v0.21.6

Community

Code of Conduct

The reconciler.io projects follow the Contributor Covenant Code of Conduct. In short, be kind and treat others with respect.

Communication

General discussion and questions about the project can occur either on the Kubernetes Slack #reconcilerio channel, or in the project's GitHub discussions. Use the channel you find most comfortable.

Contributing

The reconciler.io project team welcomes contributions from the community. A contributor license agreement (CLA) is not required. You own full rights to your contribution and agree to license the work to the community under the Apache License v2.0, via a Developer Certificate of Origin (DCO). For more detailed information, refer to CONTRIBUTING.md.

License

Apache License v2.0: see LICENSE for details.