renovate

mirror of https://github.com/renovatebot/renovate.git synced 2025-01-12 23:16:26 +00:00

History

Rhys Arkins 2419878761 logs: dedupe err.message		2019-04-08 08:52:04 +02:00
..
extract.js	logs: dedupe err.message	2019-04-08 08:52:04 +02:00
index.js	refactor: rename extractDependencies -> extractPackageFile	2018-11-04 18:51:23 +01:00
readme.md	docs: add implementation status to manager readme’s	2019-03-07 12:10:57 +01:00
update.js	refactor: rename version -> value (#2076 )	2018-06-04 05:48:20 +02:00

readme.md

Overview

Name of package manager

Buildkite

Implementation status

Implemented

What language does this support?

N/A

Does that language have other (competing?) package managers?

N/A

Package File Detection

What type of package files and names does it use?

Filenames can be custom, but the tool automatically looks in:

buildkite.yml

buildkite.yaml

buildkite.json

.buildkite/pipeline.yml

.buildkite/pipeline.yaml

.buildkite/pipeline.json

What fileMatch pattern(s) should be used?

['buildkite\\.ya?ml', '\\.buildkite/.+\\.ya?ml$']

Is it likely that many users would need to extend this pattern for custom file names?

Only a small percentage of Buildkite users should need to add additional fileMatch patterns.

Is the fileMatch pattern likely to get many "false hits" for files that have nothing to do with package management?

Unlikely

Parsing and Extraction

Can package files have "local" links to each other that need to be resolved?

Is there reason why package files need to be parsed together (in serial) instead of independently?

What format/syntax is the package file in? e.g. JSON, TOML, custom?

YAML is recommended. JSON is possible but won't be supported.

How do you suggest parsing the file? Using an off-the-shelf parser, using regex, or can it be custom-parsed line by line?

Parsing YAML line-by-line, looking only for the lines that interest us.

Does the package file structure distinguish between different "types" of dependencies? e.g. production dependencies, dev dependencies, etc?

List all the sources/syntaxes of dependencies that can be extracted:

From https://buildkite.com/docs/pipelines/plugins#plugin-sources:

If you refer to a plugin just by name, it defaults to https://github.com/buildkite-plugins/<name>-buildkite-plugin. For example, a plugin name of docker would resolve to https://github.com/buildkite-plugins/docker-buildkite-plugin.

To refer to a plugin in your own GitHub organization, prefix the name with the organization. For example, a plugin name of my-org/docker would resolve to https://github.com/my-org/docker-buildkite-plugin.

The following are not supported and skipped over:

You can also use fully qualified Git URLs instead of names, to refer to plugins that aren’t on GitHub, or live in private Git repositories only accessible to your agents. For example:

https://github.com/my-org/my-plugin.git#v1.0.0
ssh://git@github.com/my-org/my-plugin.git#v1.0.0
file:///a-local-path/my-plugin.git#v1.0.0
Branches, tags and commits are all valid after the #.

Describe which types of dependencies above are supported and which will be implemented in future:

The two short forms of GitHub dependencies described above are supported, but fully qualified Git URLs are not.

Versioning

What versioning scheme do the package files use?

Semver

Does this versioning scheme support range constraints, e.g. `^1.0.0` or `1.x`?

Is this package manager used for applications, libraries, or both? If both, is there a way to tell which is which?

Everything can be thought of as an application.

If ranges are supported, are there any cases when Renovate should pin ranges to exact versions if rangeStrategy=auto?

N/A because syntax doesn't support ranges.

Lookup

Is a new datasource required? Provide details

No, it can use existing GitHub datasource (tags).

Will users need the capability to specify a custom host/registry to look up? Can it be found within the package files, or within other files inside the repository, or would it require Renovate configuration?

No.

Do the package files contain any "constraints" on the parent language (e.g. supports only v3.x of Python) or platform (Linux, Windows, etc) that should be used in the lookup procedure?

Will users need the ability to configure language or other constraints using Renovate config?

Artifacts

Are lock files or checksum files used? Mandatory?

Not in use

If so, what tool and exact commands should be used if updating 1 or more package versions in a dependency file?

N/A

If applicable, what command should be used to generate a lock file from scratch if you already have a package file? This will be used for "lock file maintenance".

N/A

Other

Is there anything else to know about this package manager?

Buildkite is a great service and the company uses Renovate!

readme.md Unescape Escape