com.spotify.docker

Class TagMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.spotify.docker.AbstractDockerMojo

com.spotify.docker.TagMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="tag")
public class TagMojo
extends AbstractDockerMojo

Applies a tag to a docker image. Optionally, useGitCommitId can be used to generate a tag consisting of the first 7 characters of the most recent git commit ID.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	forceTags Flag to use force option while tagging.
private String	image Can be either an image ID (e.g.
private String	newName The new name that will be applied to the source image.
private boolean	pushImage Flag to push image after it is tagged.
private boolean	skipDockerTag Flag to skip tagging, making goal a no-op.
private String	tagInfoFile Path to JSON file to write when tagging images
private boolean	useGitCommitId If specified as true, a tag will be generated consisting of the first 7 characters of the most recent git commit ID, resulting in something like image:df8e8e6.

Fields inherited from class com.spotify.docker.AbstractDockerMojo

execution, session

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
TagMojo()

Method Summary

Modifier and Type	Method and Description
protected void	execute(com.spotify.docker.client.DockerClient docker)

Methods inherited from class com.spotify.docker.AbstractDockerMojo

execute, getBuilder, rawDockerHost

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

image

@Parameter(property="image",
           required=true)
private String image

Can be either an image ID (e.g. 8dbd9e392a96), or an image name with an optional tag. If no tag is specified, the docker daemon will automatically try to use the tag 'latest'.

skipDockerTag

@Parameter(property="skipDockerTag",
           defaultValue="false")
private boolean skipDockerTag

Flag to skip tagging, making goal a no-op. This can be useful when docker:tag is bound to the package goal, and you want to mvn package without tagging the image. Defaults to false.

newName

@Parameter(property="newName",
           required=true)
private String newName

The new name that will be applied to the source image. If a tag is not specified, the docker daemon will automatically apply the tag 'latest' to the specified repo. Only a repo without a tag should be specified if useGitCommitId is set to true.

pushImage

@Parameter(property="pushImage",
           defaultValue="false")
private boolean pushImage

Flag to push image after it is tagged.

forceTags

@Parameter(property="forceTags",
           defaultValue="false")
private boolean forceTags

Flag to use force option while tagging. Defaults to false.

tagInfoFile

@Parameter(property="tagInfoFile")
private String tagInfoFile

Path to JSON file to write when tagging images

useGitCommitId

@Parameter(property="useGitCommitId",
           defaultValue="false")
private boolean useGitCommitId

If specified as true, a tag will be generated consisting of the first 7 characters of the most recent git commit ID, resulting in something like image:df8e8e6. If there are any changes not yet committed, the string '.DIRTY' will be appended to the end. Note, if a tag is explicitly specified in the newName parameter, this flag will be ignored.

Constructor Detail

TagMojo

public TagMojo()

Method Detail

execute

protected void execute(com.spotify.docker.client.DockerClient docker)
                throws org.apache.maven.plugin.MojoExecutionException,
                       com.spotify.docker.client.DockerException,
                       IOException,
                       InterruptedException,
                       org.eclipse.jgit.api.errors.GitAPIException

Specified by:

execute in class AbstractDockerMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

com.spotify.docker.client.DockerException

IOException

InterruptedException

org.eclipse.jgit.api.errors.GitAPIException