Skip to content

The Unified and Autonomous Development Platform

chore: Minor help improvements

Robin Shen740dd4100938
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/BuildImageStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/BuildImageStep.java
index 3602831fdc..5e621b225c 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/BuildImageStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/BuildImageStep.java
@@ -133,9 +133,10 @@ public class BuildImageStep extends Step {
private String tags;
- @Editable(description="Specify full tag of the image, for instance <tt>myorg/myrepo:latest</tt>, " +
- "<tt>myorg/myrepo:1.0.0</tt>, or <tt>onedev.example.com/myproject/myrepo:1.0.0</tt>. " +
- "Multiple tags should be separated with space")
+ @Editable(description="Specify image tags to push, for instance <tt>registry-server:5000/myorg/myrepo:latest</tt>. " +
+ "Make sure to use <b>same host</b> as specified in server url of system settings if you want to push to " +
+ "built-in registry, or simply use the form <tt>@server@/&lt;project path&gt;/&lt;repo name&gt;:&lt;tag name&gt;</tt>. Multiple " +
+ "tags should be separated with space")
@Interpolative(variableSuggester="suggestVariables")
@NotEmpty
public String getTags() {
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/BuildImageWithKanikoStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/BuildImageWithKanikoStep.java
index 668d0e5587..d4e5cd793a 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/BuildImageWithKanikoStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/BuildImageWithKanikoStep.java
@@ -174,9 +174,10 @@ public class BuildImageWithKanikoStep extends CommandStep {
private String destinations;
- @Editable(order=300, description="Specify destinations, for instance <tt>myorg/myrepo:latest</tt>, "
- + "<tt>myorg/myrepo:1.0.0</tt>, or <tt>myregistry:5000/myorg/myrepo:1.0.0</tt>. "
- + "Multiple destinations should be separated with space.<br>")
+ @Editable(order=300, description="Specify destinations, for instance <tt>registry-server:5000/myorg/myrepo:latest</tt>. " +
+ "Make sure to use <b>same host</b> as specified in server url of system settings if you want to push to " +
+ "built-in registry, or simply use the form <tt>@server@/&lt;project path&gt;/&lt;repo name&gt;:&lt;tag name&gt;</tt>. Multiple " +
+ "destinations should be separated with space")
@Interpolative(variableSuggester="suggestVariables")
@NotEmpty
public String getDestinations() {
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/PullImageStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/PullImageStep.java
index 1a28581db1..a98520674b 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/PullImageStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/PullImageStep.java
@@ -24,8 +24,10 @@ public class PullImageStep extends CraneStep {
private String moreOptions;
- @Editable(order=100, name="Source Docker Image", description="Specify full tag of source docker image to pull from, " +
- "for instance <tt>registry-server/org/repo:tag</tt>")
+ @Editable(order=100, name="Source Docker Image", description="Specify image tag to pull from, for instance " +
+ "<tt>registry-server:5000/myorg/myrepo:latest</tt>. Make sure to use <b>same host</b> as " +
+ "specified in server url of system settings if you want to pull from built-in registry, or simply " +
+ "use the form <tt>@server@/&lt;project path&gt;/&lt;repo name&gt;:&lt;tag name&gt;</tt>")
@Interpolative(variableSuggester="suggestVariables")
@NotEmpty
public String getSrcImage() {
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/PushImageStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/PushImageStep.java
index df31268a30..36be3d5311 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/PushImageStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/PushImageStep.java
@@ -35,8 +35,10 @@ public class PushImageStep extends CraneStep {
this.srcPath = srcPath;
}
- @Editable(order=200, name="Target Docker Image", description="Specify full tag of target docker image to push to, " +
- "for instance <tt>registry-server/org/repo:tag</tt>")
+ @Editable(order=200, name="Target Docker Image", description="Specify image tag to push to, for instance " +
+ "<tt>registry-server:5000/myorg/myrepo:latest</tt>. Make sure to use <b>same host</b> as " +
+ "specified in server url of system settings if you want to push to built-in registry, or simply " +
+ "use the form <tt>@server@/&lt;project path&gt;/&lt;repo name&gt;:&lt;tag name&gt;</tt>")
@Interpolative(variableSuggester="suggestVariables")
@NotEmpty
public String getDestImage() {
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/SCPCommandStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/SCPCommandStep.java
index d9dbbf8ae1..82839e0f71 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/SCPCommandStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/SCPCommandStep.java
@@ -31,7 +31,7 @@ public class SCPCommandStep extends CommandStep {
private String options;
@Editable(order=200, description="Specify a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> to be used as private key for SSH authentication. " +
- "<b class='text-warning'>WARNING:</b> Private key with passphrase is not supported")
+ "<b class='text-info'>NOTE:</b> Private key with passphrase is not supported")
@ChoiceProvider("getPrivateKeySecretChoices")
@NotEmpty
public String getPrivateKeySecret() {
@@ -58,7 +58,8 @@ public class SCPCommandStep extends CommandStep {
this.source = source;
}
- @Editable(order=400, description = "Specify target param for SCP command, for instance <code>user@host:/app</code>")
+ @Editable(order=400, description = "Specify target param for SCP command, for instance <code>user@@host:/app</code>. " +
+ "<b class='text-info'>NOTE:</b> Make sure that scp command is installed on remote host")
@Interpolative(variableSuggester="suggestVariables")
@NotEmpty
public String getTarget() {
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/SSHCommandStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/SSHCommandStep.java
index 3d0d7c9b75..ad74457133 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/SSHCommandStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/SSHCommandStep.java
@@ -56,7 +56,7 @@ public class SSHCommandStep extends CommandStep {
}
@Editable(order=200, description="Specify a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> to be used as private key of above user " +
- "for SSH authentication. <b class='text-warning'>WARNING:</b> Private key with passphrase is not supported")
+ "for SSH authentication. <b class='text-info'>NOTE:</b> Private key with passphrase is not supported")
@ChoiceProvider("getPrivateKeySecretChoices")
@NotEmpty
public String getPrivateKeySecret() {