int128 / int128/gradle-ssh-plugin

Lack of documentation for get

Open
#310 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Groovy
Stars
325
Forks
59
Avg merge
5h 29m
Merged PRs (30d)
6

Description

Problem: get destination required absolute path instead of relative/projectDir.

I've got this problem when trying to get generated files from my server.
This link does not told about absolute path. So I end-up myself to use projectDir.getAbsolutePath();

Environment info

gradle-ssh-plugin-2.7.1 (groovy-ssh-2.7.1, jsch-0.1.53, groovy-2.4.11, java-1.8.0_111)

Steps to reproduce
  1. Create a submodule
  2. Create remote and get file from remote
  3. Build from root project.

settings.gradle:

include 'libs'
project(':libs').projectDir = new File('thrift')

build.gradle

compile project(":libs")

thirft/build.gradle

task genThriftJar {
    doLast {
        def projectLocaltion = projectDir.getAbsolutePath();
        ssh.run {
            session(remotes.compilerServer) {
                // Delete existing thrift file.
                cleanGeneratedFiles()
                put from: file("thrift/$serviceName" + ".thrift"), into: "$compilerLocation/$serviceName" + ".thrift"
                execute "mkdir -p $compilerLocation/gen-java"
                def compileResult = execute "bash $compilerLocation/genjar $serviceName", logging: 'stdout', pty: true
                assert compileResult.contains('SUCCESSFUL')
                get from: "$compilerLocation/$serviceName" + '.jar', into: "libs/"
            }
        }
    }
}

P/s: Sorry for my bad English.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked “Transfer a file or directory” documentation section and review how the get destination is described. Update the documentation to state the absolute-path requirement and clarify how relative paths or projectDir should be handled; done means the example and wording no longer leave this behavior implicit.

Written by the indexing model from the issue text.

Assessment

Tech stack
groovy
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.