LabelSchemaFactory: Create Build-time labels according to Label Schema Convention

Description Usage Details Value See Also Examples

View source: R/LabelSchemaFactory.R

Description

This is a convenience function that generates method for conveniently creating metadata-labels with arguments according to schema version 1.0.0-rc.1

Usage

1

Details

For details about the Label Schema, see http://label-schema.org/rc1/

Value

The returned function alows to create labels using the defined label names, e.g. version for org.label-schema.version. For convenience, dashes are replaced by underscores in argument names. Also, the schema-version is set by default as part of the label.

The names that can be used according to are the following:

schema_version, version, build_date, name, description, usage, url, vcs_url, vcs_ref, vendor, docker.cmd, docker.cmd.devel, docker.cmd.test, docker.debug, docker.cmd.help, docker.params, rkt.cmd, rkt.cmd.devel, rkt.cmd.test, rkt.debug, rkt.cmd.help, rkt.params

See Also

Other label: Label-class, Label_Maintainer(), Label_SessionInfo(), Label

Examples

1
2
3
4
5
6
7
8
the_dockerfile <- dockerfile(clean_session())
factory <- LabelSchemaFactory()
label <- factory(name = "ImageName",
  description = "Description of the image",
  build_date = Sys.time()
 )
addInstruction(the_dockerfile) <- label
cat(format(the_dockerfile))

o2r-project/containerit documentation built on June 28, 2021, 2:46 p.m.