jfrog / jenkins-jfrog-plugin

Easy integration between Jenkins and the JFrog Platform.
https://github.com/jfrog/jenkins-jfrog-plugin
Apache License 2.0
40 stars 18 forks source link

Documentation not clear #23

Closed amandel closed 1 year ago

amandel commented 1 year ago

Describe the bug

Information in README.md not sufficient for setup.

Current behavior

Setting up the integration based on the README.md section Automatic installation from Artifactory.

Step 1 proposes to set up a jfrog-cli-remote repository. But it does not explain the settings to use for the repo. At least the repository type should be documented to avoid guessing.

In step 3 there is a typo jfrog-cli-remote is now called jfrog-cle-remote.

Reproduction steps

No response

Expected behavior

No response

JFrog plugin version

head 8ba9e663b155d3067d9b81597a8041a30f4b8c66

JFrog CLI version

not relevant

Operating system type and version

not relevant

JFrog Artifactory version

No response

JFrog Xray version

No response

yahavi commented 1 year ago

@amandel thanks for reporting this issue! The required type of the remote repository is "Generic". We'll add it to the README and we will fix the typo.

amandel commented 1 year ago

Thanks for looking into this. Using Generic feels obvious but it did not work for me in the 1st place because of a different issue. So it was not clear to me what could be the cause.