The octopus-deploy-plugin generates build-information and uploads packages and generated build-information to Octopus Deploy instances.

Requirements:

• Octopus Deploy CLI
• git (for commit/changelog calculation)

The plugin can be configured with the octopus DSL block:

plugins {
    id("com.liftric.octopus-deploy-plugin") version "whatever"
}
[...]
octopus {
    serverUrl.set("http://localhost:8080/")
    apiKey.set("API-TESTTEST123TRESDTSDD")

    generateChangelogSinceLastTag = true

    val jar by tasks.existing(Jar::class)
    packageName.set(jar.get().archiveBaseName.get())
    version.set(jar.get().archiveVersion.get())
    pushPackage.set(jar.get().archiveFile)
}

See the example directory for a minimal, working example.

The following tasks are added by the plugin:

For normale use-cases, only uploadBuildInformation are uploadPackage are needed to call explicitly. Depending task will be called implicitly by both as needed.

Noteworthy: The build-information can be uploaded before the package itself. Useful when creating automatic releases and using the commits in the release notes in octopus.

The PromoteReleaseTask has no default implementation and must be created explicitly:

import com.liftric.octopusdeploy.task.PromoteReleaseTask
[...]
tasks {
    val devToDemo by creating(PromoteReleaseTask::class) {
        projectName.set("example-project")
        from.set("dev")
        to.set("demo")
    }
}

Calling ./gradlew devToDemo on this example will promote the current from release of the octopus project example-project to the to environment.

Octopus deploy expects the name and version in the following format: <name>.<version>.<extension>

For Java archives, <name>-<version>.<extension> is conventional, so should be changed to get picked up properly by octopus. Otherwise the first version number part will be parsed as part of the name.

After the plugin is applied, the octopus extension is registered with the following settings:

generateChangelogSinceLastTag extracts all commits between the HEAD and the last tag. If no tag is found, the first commit in the history tree is used instead.

You can configure serverUrl and apiKey using a provider which enables configuring them on demand, not at configuration time:

apiKey.set(provider {
        "API-TESTTEST123TRESDTSDD"
        // read from file / vault / etc.
})

Both the PromoteReleaseTask and UploadPackageTask provide support for waiting for any deployment on octopus deploy and will block task finishing until all octopus deploy tasks are finished.

Basically if the upload or progression triggers a release in octopus deploy, the tasks will wait until they are completed.

Configuration is done on the tasks themself:

Example:

import com.liftric.octopusdeploy.task.PromoteReleaseTask
import com.liftric.octopusdeploy.task.UploadPackageTask
[...]
tasks {
    val devToDemo by creating(PromoteReleaseTask::class) {
        waitForReleaseDeployments.set(true)
        projectName.set("example-project")
        from.set("dev")
        to.set("staging")
    }
    withType<UploadPackageTask>() {
        waitForReleaseDeployments.set(true)
    }
}

Thanks to Octopus Deploy for the permission to use the header image.