自定义Gradle任务取决于插件

时间:2020-09-19 15:58:44

标签: gradle gradle-plugin gradle-task

摘要:我想编写一个gradle任务,该任务取决于插件。特别是我想将插件org.hidetake.ssh用于部署任务

我有以下项目结构

build.gradle
settings.gradle
some-modules/
|-- src/...
buildSrc/
|-- src/
|-- |-- main/groovy/package/DeployTask
|-- build.gradle

在我的主要build.gradle中,导入插件并定义Task: build.gradle

plugins {
    id 'idea'
    id 'org.hidetake.ssh' version '2.10.1'
}

...

remotes {
    dev {
        host = findProperty("server.dev.host")
        user = findProperty("server.dev.user")
        identity = file(findProperty("server.dev.identity_file") ?: "${System.properties['user.home']}/.ssh/id_rsa")
    }
}

import org.irrigation.gradle.DeployTask

task deploy(type: DeployTask) {
    description = "Deploys to Server"
}

然后在buildSrc/src/main/package/DeployTask中定义它:

class DeployTask extends DefaultTask {
    @Input
    @Option(option = "env", description = "Configures the environment to be used")
    String environment = "dev";

    @Input
    @Option(option = "branch", description = "Configures the branch which should be deployed")
    String branch = "master";

    @TaskAction
    void deploy() {
        ssh.run {
            session(ssh.remotes[environment]) {
                execute "echo test"
            }
        }
    }

}

我显然收到错误消息:

Execution failed for task ':deploy'.
> Could not get unknown property 'ssh' for task ':deploy' of type org.irrigation.gradle.DeployTask.

问题是,我可以(但不想)在主build.gradle中编写任务,如下所示(没有错误)

task deploy(type: DeployTask) {
    doLast {
        ssh.run {
            session(ssh.remotes[environment]) {
                execute "echo test"
            }
        }
    }
}

1 个答案:

答案 0 :(得分:1)

LinkedBlockingQueue<String> bufferQueue = injector.getProvider(LinkedBlockingQueue.class).get(); 被注册为项目的扩展名:https://github.com/int128/gradle-ssh-plugin/blob/master/gradle-ssh-plugin/core/src/main/groovy/org/hidetake/gradle/ssh/plugin/SshPlugin.groovy#L20

因此,您需要在任务中引用扩展名,如下所示(未经测试):

ssh