rlsbl v0.92.0 /rlsbl.targets.go
Updated
On this page

Go release target using a VERSION file as source of truth, with GoReleaser integration for binaries and module proxy notification for libs.

#rlsbl.targets.go

#rlsbl.targets.go

Go release target using a VERSION file as source of truth, with GoReleaser integration for binaries and module proxy notification for libs.

#_go_archive_fn

python
def _go_archive_fn(spec, name)

Return (asset_pattern, extract_cmd, binary_name) for a Go/goreleaser build.

#GoTarget

Release target for Go projects (go.mod + VERSION file).

#name

python
def name(self)

#detect

python
def detect(self, dir_path)

#read_name

python
def read_name(self, dir_path, ctx)

Read the last segment of the module path from go.mod.

#read_metadata

python
def read_metadata(self, dir_path)

Go modules have no license/description in go.mod.

#_is_library

python
def _is_library(self, dir_path)

Return True if the project has no package main in root .go files or cmd/ layout.

#_has_root_main

python
def _has_root_main(self, dir_path)

Return True if there's a main.go at the project root with package main.

#_has_version_var

python
def _has_version_var(self, dir_path)

Return True if any root-level .go file declares a Version variable.

#_has_cmd_main

python
def _has_cmd_main(self, dir_path)

Return True if there's a single cmd/*/main.go with package main.

Returns False if there are multiple cmd/ subdirectories (multi-binary repos where cmd/ is the correct layout) or no cmd/ entries at all.

#read_version

python
def read_version(self, dir_path)

Read version from the VERSION file.

#write_version

python
def write_version(self, dir_path, version, ctx)

Write the new version to the VERSION file.

Returns a list of relative file paths that were modified.

#version_file

python
def version_file(self, dir_path=None)

#tag_format

python
def tag_format(self, version)

#companion_tags

python
def companion_tags(self, name, version, path=None)

Return Go module proxy companion tags for monorepo packages.

When path is set (monorepo member), the Go module proxy needs a tag of the form {path}/v{version} to resolve the module. This tag is identical to the Go target's primary monorepo_tag_format output, so it is only useful as a companion when a different target (e.g. npm) is the primary release target and produces a non-Go-compatible primary tag.

#monorepo_tag_format

python
def monorepo_tag_format(self, name, version, path=None)

#monorepo_tag_glob

python
def monorepo_tag_glob(self, name, path=None)

#template_dir

python
def template_dir(self)

#template_vars

python
def template_vars(self, dir_path, ctx)

Extract template variables from go.mod and .rlsbl/config.json.

#template_mappings

python
def template_mappings(self, ctx)

#shared_template_mappings

python
def shared_template_mappings(self, ctx)

#check_project_exists

python
def check_project_exists(self, dir_path)

#get_project_init_hint

python
def get_project_init_hint(self)

#dev_install_command

python
def dev_install_command(self, project_dir)