dispatch-catalog

Git

This module provides methods useful for working with git repositories.

To import, add the following to your Dispatchfile:

load("github.com/mesosphere/dispatch-catalog/starlark/stable/git@0.0.7", "generate_version")

git_resource(name, url, revision, pipeline)

Define a new git resource in a pipeline.

If url is not set, it defaults to the Git URL triggering this build, i.e., “$(context.git.url)”. If revision is not set, it defaults to the commit SHA triggering this build, i.e., “$(context.git.commit)”.

Example usage: git_resource("my-git", url="https://github.com/mesosphere/dispatch", revision="dev")

gitResource(name, url, revision, pipeline)

DEPRECATED: Use git_resource instead.

git_revision(name)

Shorthand for input git revision.

Returns string “$(resources.inputs..revision)"

git_checkout_dir(name)

Shorthand for input git checkout directory.

Returns string “$(resources.inputs..path)".

generate_version(git, name)

Generates a version number from the git repository. It uses the output of git describe --tags as the version number. If the commit is tagged, the tag will be used. If the commit is not tagged, it will use the most recent tag in the tree concatenated with the commit index and the short commit id (e.g., “1.2.0-154-geb24b488”).

Arguments:

• git: the git repository resource to use for calculating the version.
• name: the name of the task to create.

Returns the task result variable name that can be used to access the version. A task using the version number must list the version task name (the value specified in the name argument) in the task’s inputs and then the variable can be accessed from within the task.

Example usage:

git          = git_resource("git")
version_task = "generate-version"
version      = generate_version(git, version_task)

task("print-version", inputs=[version_task], steps=[
    k8s.corev1.Container(
        name="print-version",
        image="alpine",
        command=[
            "/bin/ash", "-c", "echo {}".format(version)
        ]
    )
])

This site is open source. Improve this page.