-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding templates for each explanation
- Loading branch information
1 parent
2325f92
commit c31e2ab
Showing
4 changed files
with
65 additions
and
0 deletions.
There are no files selected for viewing
17 changes: 17 additions & 0 deletions
17
Results/Templates/direct_dependency_explanation_template.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
* <summary> < Method | Class | Field | Import | Constructor> <b>< instruction name ></b> which has been < <b>Removed | Modified </b> > in the new version of the dependency</summary> | ||
|
||
* <summary>The failure is identified from the logs generated in the build process. </summary> | ||
|
||
* > 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> | ||
``` | ||
|
20 changes: 20 additions & 0 deletions
20
Results/Templates/indirect_dependency_explanation_template.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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**>). | ||
|
||
<details> | ||
<summary>Here you can find a list of failures identified from the logs generated in the build process</summary> | ||
|
||
* > 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 > | ||
``` | ||
</details> | ||
|
17 changes: 17 additions & 0 deletions
17
Results/Templates/java_version_incompatibility_explanation_template.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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` | ||
|
||
<details> | ||
<summary>Here you can find a list of failures identified from the logs generated in the build process</summary> | ||
|
||
* > Label to indicate the error message in the logs | ||
* > Label to indicate the error message in the logs | ||
</details> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
|
||
<details> | ||
<summary>Here you can find a list of warnings identified from the logs generated in the build process</summary> | ||
|
||
* > Label to indicate the error message in the logs | ||
* > Label to indicate the error message in the logs | ||
</details> |