From c31e2ab509cbf26114f6f35dc56084c8df6820b0 Mon Sep 17 00:00:00 2001 From: Frank Reyes Date: Mon, 26 Aug 2024 11:52:58 +0200 Subject: [PATCH] Adding templates for each explanation --- .../direct_dependency_explanation_template.md | 17 ++++++++++++++++ ...ndirect_dependency_explanation_template.md | 20 +++++++++++++++++++ ...on_incompatibility_explanation_template.md | 17 ++++++++++++++++ .../Templates/werror_exlpanation_template.md | 11 ++++++++++ 4 files changed, 65 insertions(+) create mode 100644 Results/Templates/direct_dependency_explanation_template.md create mode 100644 Results/Templates/indirect_dependency_explanation_template.md create mode 100644 Results/Templates/java_version_incompatibility_explanation_template.md create mode 100644 Results/Templates/werror_exlpanation_template.md diff --git a/Results/Templates/direct_dependency_explanation_template.md b/Results/Templates/direct_dependency_explanation_template.md new file mode 100644 index 0000000..5a9c6a2 --- /dev/null +++ b/Results/Templates/direct_dependency_explanation_template.md @@ -0,0 +1,17 @@ +CI detected that the dependency upgrade from version <**label indicating the previous version of the dependency**> to <**label indicating the new version of the dependency**> has failed. Here are details to help you understand and fix the problem: +1. Your client utilizes <**label indicate amount of instructions**> instructions which has been modified in the new version of the dependency. + * < Method | Class | Field | Import | Constructor> < instruction name > which has been < Removed | Modified > in the new version of the dependency + + * The failure is identified from the logs generated in the build process. + + * > Label to indicate the error message in the logs + * An error was detected in line < Label indicate line in client> which is making use of an outdated API. + ``` java + < Line in client > + ``` + + To resolve this issue, there are alternative options available in the new version of the dependency that can replace the incompatible method currently used in the client. You can consider substituting the existing method with one of the following options provided by the new version of the dependency + ``` java + < New method signature> + ``` + diff --git a/Results/Templates/indirect_dependency_explanation_template.md b/Results/Templates/indirect_dependency_explanation_template.md new file mode 100644 index 0000000..ba233b3 --- /dev/null +++ b/Results/Templates/indirect_dependency_explanation_template.md @@ -0,0 +1,20 @@ +CI detected that the dependency upgrade from version <**label indicating the previous version of the dependency**> to <**label indicating the new version of the dependency**> has failed. Here are +details to help you understand and fix the problem: + +Your code depends on indirect dependency <**label indicating indirect dependency**> which has been removed in the new version of the updated dependency (<**label indicating the new version of the dependency**>). + +
+Here you can find a list of failures identified from the logs generated in the build process + + * > Label to indicate the error message in the logs + * An error was detected in line < Label indicate line in client> which is making use of an outdated API. + ``` java + < Line in client > + ``` + * > Label to indicate the error message in the logs + * An error was detected in line < Label indicate line in client> which is making use of an outdated API. + ``` java + < Line in client > + ``` +
+ diff --git a/Results/Templates/java_version_incompatibility_explanation_template.md b/Results/Templates/java_version_incompatibility_explanation_template.md new file mode 100644 index 0000000..468272e --- /dev/null +++ b/Results/Templates/java_version_incompatibility_explanation_template.md @@ -0,0 +1,17 @@ +CI detected that the dependency upgrade from version <**label indicating the previous version of the dependency**> to <**label indicating the new version of the dependency**> has failed. + +The new version of the dependency require a different version of Java. + +CI uses Java <**current Java version**>. The new version of the dependency requires Java <**required Java version**>. + +To resolve this issue, you need to update the Java version in the following files to the version required by the new dependency: + +- `maven.yml` +- `build.yml` + +
+Here you can find a list of failures identified from the logs generated in the build process + +* > Label to indicate the error message in the logs +* > Label to indicate the error message in the logs +
diff --git a/Results/Templates/werror_exlpanation_template.md b/Results/Templates/werror_exlpanation_template.md new file mode 100644 index 0000000..18de9bc --- /dev/null +++ b/Results/Templates/werror_exlpanation_template.md @@ -0,0 +1,11 @@ +CI detected that the dependency upgrade from version <**label indicating the previous version of the dependency**> to <**label indicating the new version of the dependency**> has failed. Here are details to help you understand and fix the problem: + +1. This occur because the option **failureOnWarning** is activated in the following files: + - pom.xml + +
+Here you can find a list of warnings identified from the logs generated in the build process + +* > Label to indicate the error message in the logs +* > Label to indicate the error message in the logs +