META-INF.revapi.ftl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of quarkus-revapi-config
Contains the configuration of the Revapi API checker and the list of the API changes in the Quarkus APIs.
The newest version!
<#ftl strip_whitespace=true>
<#if reports?has_content>
# API Change analysis Results

The summary of the API changes between artifacts <#list analysis.oldApi.archives as archive>`${archive.name}`<#sep>,  and 
<#list analysis.newApi.archives as archive>`${archive.name}`<#sep>, 

<#assign oldSupplementaryArchives = analysis.oldApi.supplementaryArchives>
<#assign newSupplementaryArchives = analysis.newApi.supplementaryArchives>

<#assign oldDependencyNames = oldSupplementaryArchives?map(supplementaryArchive -> supplementaryArchive.name)>
<#assign newDependencyNames = newSupplementaryArchives?map(supplementaryArchive -> supplementaryArchive.name)>

<#assign oldDependencyBaseNames = oldSupplementaryArchives?map(supplementaryArchive -> supplementaryArchive.baseName)>
<#assign newDependencyBaseNames = newSupplementaryArchives?map(supplementaryArchive -> supplementaryArchive.baseName)>

<#assign removedDependencyNames = oldDependencyNames?filter(name -> !newDependencyBaseNames?seq_contains(name?keep_before_last(":")))>
<#assign addedDependencyNames = newDependencyNames?filter(name -> !oldDependencyBaseNames?seq_contains(name?keep_before_last(":")))>

<#assign count = 0>
<#compress>
[cols="1,1"]
|===
|*Total API Changes* |


|Classes Changed
|<#list reports as report>
<#list report.differences as diff>
<#if diff.code?contains("class")>
<#assign count++>



xref:classes[${count}]

<#assign count = 0>
|Methods Changed
|<#list reports as report>
<#list report.differences as diff>
<#if diff.code?contains("method")><#assign count++>


xref:methods[${count}]

<#assign count = 0>
|Fields Changed
|<#list reports as report>
<#list report.differences as diff>
<#if diff.code?contains("field")><#assign count++>


xref:fields[${count}]

<#assign count = 0>
|Other Changes
|<#list reports as report>
<#list report.differences as diff>
<#if !diff.code?contains("field") && !diff.code?contains("class") && !diff.code?contains("method") ><#assign count++>


xref:others[${count}]

|Dependencies Added
|xref:added[${addedDependencyNames?size}]

|Dependencies Removed
|xref:removed[${removedDependencyNames?size}]

<#assign count = 0>
|Dependencies Changed
|<#list oldSupplementaryArchives as oldArchive>
 <#list newSupplementaryArchives as newArchive>
 <#if oldArchive.baseName == newArchive.baseName>
 <#assign oldVersion=oldArchive.version?replace('[^\\d]','','r')>
 <#assign newVersion=newArchive.version?replace('[^\\d]','','r')>
 <#if (newVersion?number> oldVersion?number)?c?boolean || (newVersion?number < oldVersion?number)?c?boolean>
 <#assign count++>
 
 
 
 
 xref:dependencyChange[${count}]

|===



=== [[classes]]Classes Changed
<#list reports as report>
<#list report.differences as diff>
<#if diff.code?contains("class")>
===============================
[.lead]
*${diff.code}* : <#if report.newElement??>
<#assign temp = report.newElement?split(" ")[0]>
${report.newElement?replace(temp, "")} +

<#if report.oldElement??>
<#assign temp = report.oldElement?split(" ")[0]>
${report.oldElement?replace(temp, "")}


${diff.description} +
<#list diff.attachments?keys as key>
<#if !['newArchive', 'newArchiveRole', 'oldArchive', 'oldArchiveRole','package','classQualifiedName','classSimpleName','elementKind','exception','methodName','exampleUseChainInNewApi','exampleUseChainInOldApi','fieldName']?seq_contains(key)>
  ${key} = ${diff.attachments[key]}

 +
<#list diff.classification?keys as compat>
<#if diff.classification?api.get(compat) != "NON_BREAKING">
*${compat?capitalize} Compatibility*: ${diff.classification?api.get(compat)?capitalize?replace("_","")},


${diff.justification!""}
===============================




=== [[fields]]Fields Changed
<#list reports as report>
<#list report.differences as diff>
<#if diff.code?contains("field")>
===============================
[.lead]
*${diff.code}* : <#if report.newElement??>
<#assign temp = report.newElement?split(" ")[0]>
${report.newElement?replace(temp, "")} +

<#if report.oldElement??>
<#assign temp = report.oldElement?split(" ")[0]>
${report.oldElement?replace(temp, "")}


${diff.description} +
<#list diff.attachments?keys as key>
<#if !['newArchive', 'newArchiveRole', 'oldArchive', 'oldArchiveRole','package','classQualifiedName','classSimpleName','elementKind','exception','methodName','exampleUseChainInNewApi','exampleUseChainInOldApi','fieldName']?seq_contains(key)>
  ${key} = ${diff.attachments[key]}

 +
<#list diff.classification?keys as compat>
<#if diff.classification?api.get(compat) != "NON_BREAKING">
*${compat?capitalize} Compatibility*: ${diff.classification?api.get(compat)?capitalize?replace("_","")},


${diff.justification!""}
===============================




=== [[methods]]Methods Changed
<#list reports as report>
<#list report.differences as diff>
<#if diff.code?contains("method")>
===============================
[.lead]
*${diff.code}* : <#if report.newElement??>
<#assign temp = report.newElement?split(" ")[0]>
${report.newElement?replace(temp, "")} +

<#if report.oldElement??>
<#assign temp = report.oldElement?split(" ")[0]>
${report.oldElement?replace(temp, "")}


${diff.description} +
<#list diff.attachments?keys as key>
<#if !['newArchive', 'newArchiveRole', 'oldArchive', 'oldArchiveRole','package','classQualifiedName','classSimpleName','elementKind','exception','methodName','exampleUseChainInNewApi','exampleUseChainInOldApi','fieldName']?seq_contains(key)>
  ${key} = ${diff.attachments[key]}

 +
<#list diff.classification?keys as compat>
<#if diff.classification?api.get(compat) != "NON_BREAKING">
*${compat?capitalize} Compatibility*: ${diff.classification?api.get(compat)?capitalize?replace("_","")},


${diff.justification!""}
===============================




=== [[others]]Other Changes
<#list reports as report>
<#list report.differences as diff>
<#if !diff.code?contains("field") && !diff.code?contains("class") && !diff.code?contains("method")>
===============================
[.lead]
*${diff.code}* : <#if report.newElement??>
<#assign temp = report.newElement?split(" ")[0]>
${report.newElement?replace(temp, "")} +

<#if report.oldElement??>
<#assign temp = report.oldElement?split(" ")[0]>
${report.oldElement?replace(temp, "")}


${diff.description} +
<#list diff.attachments?keys as key>
<#if !['newArchive', 'newArchiveRole', 'oldArchive', 'oldArchiveRole','package','classQualifiedName','classSimpleName','elementKind','exception','methodName','exampleUseChainInNewApi','exampleUseChainInOldApi','fieldName']?seq_contains(key)>
  ${key} = ${diff.attachments[key]}

 +
<#list diff.classification?keys as compat>
<#if diff.classification?api.get(compat) != "NON_BREAKING">
*${compat?capitalize} Compatibility*: ${diff.classification?api.get(compat)?capitalize?replace("_","")},


${diff.justification!""}
===============================




=== [[added]]Added Dependencies
<#list addedDependencyNames as name>
===============================
[.lead]
${name}
===============================


=== [[removed]]Removed Dependencies
<#list removedDependencyNames as name>
===============================
[.lead]
${name}
===============================


=== [[dependencyChange]]Changed Dependencies
<#list oldSupplementaryArchives as oldArchive>
<#list newSupplementaryArchives as newArchive>
<#if oldArchive.baseName == newArchive.baseName>
<#assign oldVersion=oldArchive.version?replace('[^\\d]','','r')>
<#assign newVersion=newArchive.version?replace('[^\\d]','','r')>
<#if (newVersion?number > oldVersion?number)?c?boolean || (newVersion?number < oldVersion?number)?c?boolean>
===============================
[.lead]
${oldArchive.name} ->  ${newArchive.name?keep_after_last(":")}
===============================