Skip to content

The Unified and Autonomous Development Platform

chore: Add job secret doc link for various settings

Robin Shena511aad72aa1
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/Import.java b/server-core/src/main/java/io/onedev/server/buildspec/Import.java
index dc817b94db..0cf6f0cf45 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/Import.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/Import.java
@@ -127,7 +127,7 @@ public class Import implements Serializable, Validatable {
return new ArrayList<>();
}
- @Editable(order=500, description="Specify a secret to be used as access token to import build spec " +
+ @Editable(order=500, description="Specify a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> to be used as access token to import build spec " +
"from above project if its code is not publicly accessible")
@ChoiceProvider("getAccessTokenSecretChoices")
@Nullable
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/Service.java b/server-core/src/main/java/io/onedev/server/buildspec/Service.java
index 93478f5c7e..96e4a8d558 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/Service.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/Service.java
@@ -115,7 +115,7 @@ public class Service implements NamedElement, Serializable {
this.runAs = runAs;
}
- @Editable(order=500, name="Built-in Registry Access Token", group="More Settings", description = "Specify access token for built-in docker registry if necessary")
+ @Editable(order=500, name="Built-in Registry Access Token", group="More Settings", description = "Optionally specify a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> to be used as access token for built-in docker registry")
@ChoiceProvider("getAccessTokenSecretChoices")
public String getBuiltInRegistryAccessTokenSecret() {
return builtInRegistryAccessTokenSecret;
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/gitcredential/HttpCredential.java b/server-core/src/main/java/io/onedev/server/buildspec/job/gitcredential/HttpCredential.java
index 827916f685..3de4a93bde 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/gitcredential/HttpCredential.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/gitcredential/HttpCredential.java
@@ -26,7 +26,7 @@ public class HttpCredential implements GitCredential, Validatable {
private String accessTokenSecret;
- @Editable(order=200, description="Specify a secret to be used as access token")
+ @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 access token")
@ChoiceProvider("getAccessTokenSecretChoices")
@NotEmpty
public String getAccessTokenSecret() {
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/gitcredential/SshCredential.java b/server-core/src/main/java/io/onedev/server/buildspec/job/gitcredential/SshCredential.java
index 73d33d5e56..b0d21df2cc 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/gitcredential/SshCredential.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/gitcredential/SshCredential.java
@@ -33,7 +33,7 @@ public class SshCredential implements GitCredential, Validatable {
private String keySecret;
- @Editable(order=100, description="Specify a secret to be used as SSH private key")
+ @Editable(order=100, description="Specify a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> to be used as SSH private key")
@ChoiceProvider("getKeySecretChoices")
@NotEmpty
public String getKeySecret() {
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 f6c54d86ef..e3d9c115b2 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
@@ -93,7 +93,7 @@ public class BuildImageStep extends Step {
private static String getBuiltInRegistryAccessTokenSecretDescription() {
var serverUrl = OneDev.getInstance(SettingManager.class).getSystemSetting().getServerUrl();
var server = UrlUtils.getServer(serverUrl);
- return "Optionally specify a secret to be used as access token for built-in registry server " +
+ return "Optionally specify a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> to be used as access token for built-in registry server " +
"<code>" + server + "</code>";
}
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 b231eed37a..334eee9c2d 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
@@ -112,7 +112,7 @@ public class BuildImageWithKanikoStep extends CommandStep {
private static String getBuiltInRegistryAccessTokenSecretDescription() {
var serverUrl = OneDev.getInstance(SettingManager.class).getSystemSetting().getServerUrl();
var server = UrlUtils.getServer(serverUrl);
- return "Optionally specify a secret to be used as access token for built-in registry server " +
+ return "Optionally specify a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> to be used as access token for built-in registry server " +
"<code>" + server + "</code>";
}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/CloseIterationStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/CloseIterationStep.java
index 4ca4dba215..69989e2ef4 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/CloseIterationStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/CloseIterationStep.java
@@ -45,7 +45,7 @@ public class CloseIterationStep extends ServerSideStep {
}
@Editable(order=1060, description="For build commit not reachable from default branch, " +
- "an access token with manage issue permission is required")
+ "a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> should be specified as access token with manage issue permission")
@ChoiceProvider("getAccessTokenSecretChoices")
public String getAccessTokenSecret() {
return accessTokenSecret;
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/CommandStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/CommandStep.java
index 353275d666..165bec25f4 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/CommandStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/CommandStep.java
@@ -115,7 +115,7 @@ public class CommandStep extends Step {
private static String getBuiltInRegistryAccessTokenSecretDescription() {
var serverUrl = OneDev.getInstance(SettingManager.class).getSystemSetting().getServerUrl();
var server = UrlUtils.getServer(serverUrl);
- return "Optionally specify a secret to be used as access token for built-in registry server " +
+ return "Optionally specify a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> to be used as access token for built-in registry server " +
"<code>" + server + "</code>";
}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/CraneStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/CraneStep.java
index b24b6c5644..abccb413d0 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/CraneStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/CraneStep.java
@@ -74,7 +74,7 @@ public abstract class CraneStep extends CommandStep {
private static String getBuiltInRegistryAccessTokenSecretDescription() {
var serverUrl = OneDev.getInstance(SettingManager.class).getSystemSetting().getServerUrl();
var server = UrlUtils.getServer(serverUrl);
- return "Optionally specify a secret to be used as access token for built-in registry server " +
+ return "Optionally specify a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> to be used as access token for built-in registry server " +
"<code>" + server + "</code>";
}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/CreateBranchStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/CreateBranchStep.java
index 45ddea555c..cc2f597e1a 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/CreateBranchStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/CreateBranchStep.java
@@ -74,7 +74,7 @@ public class CreateBranchStep extends ServerSideStep {
}
@Editable(order=1060, description="For build commit not reachable from default branch, " +
- "an access token with create branch permission is required")
+ "a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> should be specified as access token with create branch permission")
@ChoiceProvider("getAccessTokenSecretChoices")
public String getAccessTokenSecret() {
return accessTokenSecret;
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/CreateTagStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/CreateTagStep.java
index 7ee2addbfd..ec9ec0c1b6 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/CreateTagStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/CreateTagStep.java
@@ -63,7 +63,7 @@ public class CreateTagStep extends ServerSideStep {
}
@Editable(order=1060, description="For build commit not reachable from default branch, " +
- "an access token with create tag permission is required")
+ "a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> should be specified as access token with create tag permission")
@ChoiceProvider("getAccessTokenSecretChoices")
public String getAccessTokenSecret() {
return accessTokenSecret;
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/RunContainerStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/RunContainerStep.java
index 03cc68441d..c1b5dce32b 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/RunContainerStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/RunContainerStep.java
@@ -115,7 +115,7 @@ public class RunContainerStep extends Step {
}
@Editable(order=600, name="Built-in Registry Access Token Secret", group = "More Settings", description="Optionally specify a " +
- "access token secret to access built-in container registry if necessary. If this step needs to " +
+ "<a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> to be used as access token for built-in container registry. If this step needs to " +
"access external container registry, login information should be configured in corresponding " +
"executor then")
@ChoiceProvider("getAccessTokenSecretChoices")
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/RunImagetoolsStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/RunImagetoolsStep.java
index aea0b78537..977c96a0dd 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/RunImagetoolsStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/RunImagetoolsStep.java
@@ -63,7 +63,7 @@ public class RunImagetoolsStep extends Step {
private static String getBuiltInRegistryAccessTokenSecretDescription() {
var serverUrl = OneDev.getInstance(SettingManager.class).getSystemSetting().getServerUrl();
var server = UrlUtils.getServer(serverUrl);
- return "Optionally specify a secret to be used as access token for built-in registry server " +
+ return "Optionally specify a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> to be used as access token for built-in registry server " +
"<code>" + server + "</code>";
}
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 dffb68987a..8de5ed6ef9 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
@@ -30,7 +30,7 @@ public class SCPCommandStep extends CommandStep {
private String options;
- @Editable(order=200, description="Specify a secret to be used as private key for SSH authentication")
+ @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")
@ChoiceProvider("getPrivateKeySecretChoices")
@NotEmpty
public String getPrivateKeySecret() {
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 f969431dca..15585f6043 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 {
this.userName = userName;
}
- @Editable(order=200, description="Specify a secret to be used as private key of above user " +
+ @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")
@ChoiceProvider("getPrivateKeySecretChoices")
@NotEmpty
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/SetupCacheStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/SetupCacheStep.java
index 0cb2377b95..4c44e68fe8 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/SetupCacheStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/SetupCacheStep.java
@@ -130,7 +130,7 @@ public class SetupCacheStep extends Step {
return BuildSpec.suggestVariables(matchWith, true, false, false);
}
- @Editable(order=500, description = "Specify a secret whose value is an access token with upload cache permission " +
+ @Editable(order=500, description = "Specify a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> whose value is an access token with upload cache permission " +
"for above project. Note that this property is not required if upload cache to current or child project " +
"and build commit is reachable from default branch")
@ChoiceProvider("getAccessTokenSecretChoices")
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/SyncRepository.java b/server-core/src/main/java/io/onedev/server/buildspec/step/SyncRepository.java
index 8380eb72ed..4b63d150dc 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/SyncRepository.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/SyncRepository.java
@@ -63,7 +63,7 @@ public abstract class SyncRepository extends ServerSideStep {
}
@Editable(order=400, name="Password or Access Token for Remote Repository",
- description="Specify a secret to be used as password or access token to access remote repository")
+ description="Specify a <a href='https://docs.onedev.io/tutorials/cicd/job-secrets' target='_blank'>job secret</a> to be used as password or access token to access remote repository")
@ChoiceProvider("getSecretChoices")
public String getPasswordSecret() {
return passwordSecret;