Struct openshift_openapi::api::build::v1::BuildPostCommitSpec

pub struct BuildPostCommitSpec {
    pub args: Option<Vec<String>>,
    pub command: Option<Vec<String>>,
    pub script: Option<String>,
}

A BuildPostCommitSpec holds a build post commit hook specification. The hook executes a command in a temporary container running the build output image, immediately after the last layer of the image is committed and before the image is pushed to a registry. The command is executed with the current working directory ($PWD) set to the image's WORKDIR.

The build will be marked as failed if the hook execution fails. It will fail if the script or command return a non-zero exit code, or if there is any other error related to starting the temporary container.

There are five different ways to configure the hook. As an example, all forms below are equivalent and will execute rake test --verbose.

1. Shell script:

"postCommit": { "script": "rake test --verbose", }

The above is a convenient form which is equivalent to:

"postCommit": { "command": ["/bin/sh", "-ic"], "args": ["rake test --verbose"] }

2. A command as the image entrypoint:

"postCommit": { "commit": ["rake", "test", "--verbose"] }

Command overrides the image entrypoint in the exec form, as documented in Docker: https://docs.docker.com/engine/reference/builder/#entrypoint.

3. Pass arguments to the default entrypoint:

"postCommit": { "args": ["rake", "test", "--verbose"] }

This form is only useful if the image entrypoint can handle arguments.

4. Shell script with arguments:

"postCommit": { "script": "rake test $1", "args": ["--verbose"] }

This form is useful if you need to pass arguments that would otherwise be hard to quote properly in the shell script. In the script, $0 will be "/bin/sh" and $1, $2, etc, are the positional arguments from Args.

5. Command with arguments:

"postCommit": { "command": ["rake", "test"], "args": ["--verbose"] }

This form is equivalent to appending the arguments to the Command slice.

It is invalid to provide both Script and Command simultaneously. If none of the fields are specified, the hook is not executed.

Fields

args: Option<Vec<String>>

args is a list of arguments that are provided to either Command, Script or the container image's default entrypoint. The arguments are placed immediately after the command to be run.

command: Option<Vec<String>>

command is the command to run. It may not be specified with Script. This might be needed if the image doesn't have /bin/sh, or if you do not want to use a shell. In all other cases, using Script might be more convenient.

script: Option<String>

script is a shell script to be run with /bin/sh -ic. It may not be specified with Command. Use Script when a shell script is appropriate to execute the post build hook, for example for running unit tests with rake test. If you need control over the image entrypoint, or if the image does not have /bin/sh, use Command and/or Args. The -i flag is needed to support CentOS and RHEL images that use Software Collections (SCL), in order to have the appropriate collections enabled in the shell. E.g., in the Ruby image, this is necessary to make ruby, bundle and other binaries available in the PATH.

Trait Implementations

impl Clone for BuildPostCommitSpec

fn clone(&self) -> BuildPostCommitSpec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BuildPostCommitSpec

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for BuildPostCommitSpec

fn default() -> BuildPostCommitSpec

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for BuildPostCommitSpec

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<BuildPostCommitSpec> for BuildPostCommitSpec

fn eq(&self, other: &BuildPostCommitSpec) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BuildPostCommitSpec) -> bool

This method tests for !=.

impl Serialize for BuildPostCommitSpec

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BuildPostCommitSpec