Skip to content

The Unified and Autonomous Development Platform

chore: Help text improvement

Robin Shenc19ef0af660d
diff --git a/server-plugin/server-plugin-report-pylint/src/main/java/io/onedev/server/plugin/report/pylint/PublishPylintReportStep.java b/server-plugin/server-plugin-report-pylint/src/main/java/io/onedev/server/plugin/report/pylint/PublishPylintReportStep.java
index 60d8eecf7d..dfd76ee292 100644
--- a/server-plugin/server-plugin-report-pylint/src/main/java/io/onedev/server/plugin/report/pylint/PublishPylintReportStep.java
+++ b/server-plugin/server-plugin-report-pylint/src/main/java/io/onedev/server/plugin/report/pylint/PublishPylintReportStep.java
@@ -27,8 +27,8 @@ public class PublishPylintReportStep extends PublishProblemReportStep {
private static final long serialVersionUID = 1L;
@Editable(order=100, description="Specify pylint json result file relative to <a href='https://docs.onedev.io/concepts#job-workspace'>job workspace</a>. "
- + "This file can be generated with pylint json output format option, for instance <code>--output-format=json:pylint-result.json</code>. "
- + "Use * or ? for pattern match")
+ + "This file can be generated with pylint json output format option, for instance <code>--exit-zero --output-format=json:pylint-result.json</code>. "
+ + "Note that we do not fail pylint command upon violations, as this step will fail build based on configured threshold. Use * or ? for pattern match")
@Interpolative(variableSuggester="suggestVariables")
@Patterns(path=true)
@NotEmpty
diff --git a/server-plugin/server-plugin-report-ruff/src/main/java/io/onedev/server/plugin/report/ruff/PublishRuffReportStep.java b/server-plugin/server-plugin-report-ruff/src/main/java/io/onedev/server/plugin/report/ruff/PublishRuffReportStep.java
index 71ca4c08d1..15b09f695a 100644
--- a/server-plugin/server-plugin-report-ruff/src/main/java/io/onedev/server/plugin/report/ruff/PublishRuffReportStep.java
+++ b/server-plugin/server-plugin-report-ruff/src/main/java/io/onedev/server/plugin/report/ruff/PublishRuffReportStep.java
@@ -31,8 +31,8 @@ public class PublishRuffReportStep extends PublishProblemReportStep {
}
@Editable(order=100, description="Specify ruff json result file relative to <a href='https://docs.onedev.io/concepts#job-workspace'>job workspace</a>. "
- + "This file can be generated with ruff json output format option, for instance <code>--output-format json --output-file ruff-result.json</code>. "
- + "Use * or ? for pattern match")
+ + "This file can be generated with ruff json output format option, for instance <code>--exit-zero --output-format json --output-file ruff-result.json</code>. "
+ + "Note that we do not fail ruff command upon violations, as this step will fail build based on configured threshold. Use * or ? for pattern match")
@Interpolative(variableSuggester="suggestVariables")
@Patterns(path=true)
@NotEmpty