Bazelregistry

“module” defines the name of the Bazel module to query from the registry.

compatible:

• source
• condition

remark:

• it is required.

example:

• module: rules_go
• module: rules_python
• module: gazelle

“url” defines a custom registry URL.

compatible:

• source
• condition

default: https://raw.githubusercontent.com/bazelbuild/bazel-central-registry/main/modules/{module}/metadata.json

remark:

• the URL must contain the “{module}” placeholder, which is replaced with the module name.
• when unset, the official Bazel Central Registry is used.

example:

• url: https://raw.githubusercontent.com/bazelbuild/bazel-central-registry/main/modules/{module}/metadata.json
• url: https://mycompany.com/bazel-registry/modules/{module}/metadata.json

“versionfilter” defines the version pattern and its kind, such as regex, semver or latest.

compatible:

• source

default: kind: latest

remark:

• yanked versions are ignored.
• with the default filter, the highest semantic version is returned.

“kind” defines the versioning scheme used to select a version.

default: latest

remark:

• accepted values are “latest”, “semver”, “regex”, “regex/semver”, “time”, “regex/time”, “lex” and “pep440”.
• “latest” returns the last version of the list.
• “lex” sorts the versions lexicographically and returns the last one.
• “pep440” follows https://peps.python.org/pep-0440/

example:

• kind: semver

“pattern” defines the version pattern, according to “kind”.

default:

• latest: “latest”
• semver and pep440: “*”
• regex: “.*”
• time and regex/time: “2006-01-02”

remark:

• for “latest”, “latest” returns the last version, any other value must match a version exactly.
• for “semver” and “regex/semver”, it is a semantic versioning constraint.
• for “pep440”, it is a pep440 version specifier.
• for “regex”, it is a regular expression.
• for “time” and “regex/time”, it is a Go date layout.
• ignored by “lex”.

example:

• pattern: ~1.2
• pattern: “>=1.0.0 <2.0.0”
• pattern: ^v\d+.\d+.\d+$

“regex” defines the regular expression extracting the version from each entry.

remark:

• only used by the kinds “regex/semver” and “regex/time”.
• the value of the first capture group is used as the version.

example:

• regex: ^v(\d+.\d+.\d+)$

“replaceall” applies a regular expression replacement to each version before filtering.

remark:

• only used by the kinds “regex”, “regex/semver” and “regex/time”.
• the replacement runs before “pattern” or “regex” is evaluated.

example:

replaceall:
  pattern: "_"
  replacement: "."

turns “curl-8_15_0” into “curl-8.15.0”.

“strict” enforces strict semantic versioning rules when parsing versions.

default: false

remark:

• only used by the kinds “semver” and “regex/semver”.