From c4f62c05c3958c4035f61245f295c2f3d4236616 Mon Sep 17 00:00:00 2001 From: Joseph Verron Date: Mon, 23 Sep 2024 00:51:48 +0800 Subject: [PATCH] updating to RELEASE_NOTES.adoc and README.adoc update before release deployment --- README.adoc | 24 ++++++++++++++++++++---- RELEASE_NOTES.adoc | 23 +++++++++++++++++++---- 2 files changed, 39 insertions(+), 8 deletions(-) diff --git a/README.adoc b/README.adoc index 57caf293..5b993454 100644 --- a/README.adoc +++ b/README.adoc @@ -16,6 +16,13 @@ image:{proj}/actions/workflows/integrate-os.yml/badge.svg[Build Status,link={pro === {proj}/releases/tag/v2.5.0[v2.5.0] +==== Features + +* Add a way to set an ExceptionResolver to Office stamper, with `OfficeStamperConfiguration#setExceptionResolver(ExceptionResolver)` + and allows users to handle errors programmatically as was expressed in the old https://github.com/verronpro/docx-stamper/issues/65[Issue #65] +** Added an `ExceptionsResolvers` class providind default implementations +** It deprecates `setFailOnUnresolvedExpression(boolean)`, `unresolvedExpressionsDefaultValue(String)`, `replaceUnresolvedExpressions(boolean)` and `leaveEmptyOnExpressionError(boolean)`. + ==== Dependencies * Bumped `org.docx4j:docx4j-core` from version 11.4.11 to 11.5.0 @@ -23,20 +30,29 @@ image:{proj}/actions/workflows/integrate-os.yml/badge.svg[Build Status,link={pro ==== Continuous Integration -* Added Renovate settings, to improve over dependabot +* Added Renovate settings to improve over dependabot * Follow best practices for maven-gpg-plugin -* Removed github devcontainer settings +* Removed GitHub .devcontainer settings * Bumped `actions/configure-pages` to v5 * Bumped `org.pitest:pitest-maven` to 1.16.3 * Bumped `org.apache.maven.plugins:maven-javadoc-plugin` to 3.10.0 * Bumped `org.apache.maven.plugins:maven-gpg-plugin` to 3.2.5 -* Bumped `org.apache.maven.plugins:maven-site-plugin` to 3.2.5 +* Bumped `org.apache.maven.plugins:maven-site-plugin` to 3.20.0 * Bumped `org.apache.maven.plugins:maven-project-info-reports-plugin` to 3.7.0 * Bumped `org.junit.jupiter:junit-jupiter` to 5.11.0 +==== Refactorings + +* Improved some logs related to unresolved errors +* Improved comments collections + ==== Tests -* Tests can now differentiate tables with a asciidoc-like representation +* Tests can now differentiate tables with their asciidoc-like representation +* Tests can now differentate when paragraph style has the `cnfStyle` property set +* Quite a few tests have been remodeled to decrease their verbosity +* Added a regression test for https://github.com/verronpro/docx-stamper/issues/64[Issue #64] + === Previous releases notes link:RELEASE_NOTES.adoc[here] diff --git a/RELEASE_NOTES.adoc b/RELEASE_NOTES.adoc index 7ca32e20..334a6d66 100644 --- a/RELEASE_NOTES.adoc +++ b/RELEASE_NOTES.adoc @@ -3,6 +3,13 @@ == {proj}/releases/tag/v2.5.0[v2.5.0] +=== Features + +* Add a way to set an ExceptionResolver to Office stamper, with `OfficeStamperConfiguration#setExceptionResolver(ExceptionResolver)` +and allows users to handle errors programmatically as was expressed in the old https://github.com/verronpro/docx-stamper/issues/65[Issue #65] +** Added an `ExceptionsResolvers` class providind default implementations +** It deprecates `setFailOnUnresolvedExpression(boolean)`, `unresolvedExpressionsDefaultValue(String)`, `replaceUnresolvedExpressions(boolean)` and `leaveEmptyOnExpressionError(boolean)`. + === Dependencies * Bumped `org.docx4j:docx4j-core` from version 11.4.11 to 11.5.0 @@ -10,20 +17,28 @@ === Continuous Integration -* Added Renovate settings, to improve over dependabot +* Added Renovate settings to improve over dependabot * Follow best practices for maven-gpg-plugin -* Removed github devcontainer settings +* Removed GitHub .devcontainer settings * Bumped `actions/configure-pages` to v5 * Bumped `org.pitest:pitest-maven` to 1.16.3 * Bumped `org.apache.maven.plugins:maven-javadoc-plugin` to 3.10.0 * Bumped `org.apache.maven.plugins:maven-gpg-plugin` to 3.2.5 -* Bumped `org.apache.maven.plugins:maven-site-plugin` to 3.2.5 +* Bumped `org.apache.maven.plugins:maven-site-plugin` to 3.20.0 * Bumped `org.apache.maven.plugins:maven-project-info-reports-plugin` to 3.7.0 * Bumped `org.junit.jupiter:junit-jupiter` to 5.11.0 +=== Refactorings + +* Improved some logs related to unresolved errors +* Improved comments collections + === Tests -* Tests can now differentiate tables with a asciidoc-like representation +* Tests can now differentiate tables with their asciidoc-like representation +* Tests can now differentiate when paragraph style has the `cnfStyle` property set +* Quite a few tests have been remodeled to decrease their verbosity +* Added a regression test for https://github.com/verronpro/docx-stamper/issues/64[Issue #64] == {proj}/v2.4.0[v2.4.0]