updated change log documentation, examples, and properties for 4.0.0

yWorks · Nov 4, 2022 · 1f7f317 · 1f7f317
1 parent e0a892c
commit 1f7f317
Show file tree

Hide file tree

Showing 23 changed files with 38 additions and 30 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,11 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [4.0.0]
+
+### Added
+- Added `replaceContentPolicy` and `replacePathPolicy` configuration options for adjusting resource files.
+  With these policies it is possible to choose between the lenient behavior from yGuard 3.x and the strict behavior from yGuard 2.x.
 
 ### Fixed
 - Fixed treatment of NestHost and NestMembers attributes when shrinking.
 
+### Changed
+- Updated gson dependency in examples from 2.8.6 to 2.8.9
+
 ## [3.1.0]
 
 ### Added
@@ -343,7 +350,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Implemented more robust handling of Manifest files. Implementation now makes use of `java.util.jar.Manifest`.
 - The `conserveManifest` attribute of the obfuscate task now conserves the manifest in a better way.
 
-[Unreleased]: https://github.com/yworks/yguard/compare/3.1.0...HEAD
+[Unreleased]: https://github.com/yworks/yguard/compare/4.0.0...HEAD
+[4.0.0]: https://github.com/yworks/yguard/compare/3.1.0...4.0.0
 [3.1.0]: https://github.com/yworks/yguard/compare/3.0.0...3.1.0
 [3.0.0]: https://github.com/yworks/yguard/compare/2.10.0...3.0.0
 [2.10.0]: https://github.com/yworks/yguard/compare/2.9.2...2.10.0

diff --git a/docs/setup.md b/docs/setup.md
@@ -6,7 +6,7 @@ Depending on your build system, you will use [`AntRun`](http://maven.apache.org/
 Download the bundle from the [Github release page](https://github.com/yWorks/yguard/releases/latest). After downloading and extracting the `jar` files, place them in a path near to your build script. You may use absolute paths, but our examples expect the jar file to lie in the same directory as your build file. Once extracted, you can use the `yguard` element like so:
 
 ```xml
-<property name="version" value="3.1.0"/>
+<property name="version" value="4.0.0"/>
 
 <target name="yguard">
     <taskdef name="yguard" classname="com.yworks.yguard.YGuardTask" classpath="${projectDir}/yguard-${version}.jar"/>
@@ -23,7 +23,7 @@ You can use `yGuard` directly from `Maven` central. Add the `yGuard` dependency
 <dependency>
     <groupId>com.yworks</groupId>
     <artifactId>yguard</artifactId>
-    <version>3.1.0</version>
+    <version>4.0.0</version>
     <scope>compile</scope>
 </dependency>
 ```
@@ -64,7 +64,7 @@ repositories {
 }
 
 dependencies {
-  compileOnly 'com.yworks:yguard:3.1.0'
+  compileOnly 'com.yworks:yguard:4.0.0'
 }
 
 task yguard {

diff --git a/examples/annotation/build.gradle b/examples/annotation/build.gradle
@@ -9,8 +9,8 @@ repositories {
 }
 
 dependencies {
-  compile 'com.yworks:yguard:3.1.0-SNAPSHOT'
-  compile 'com.yworks:annotation:3.1.0-SNAPSHOT'
+  compile 'com.yworks:yguard:4.0.0'
+  compile 'com.yworks:annotation:4.0.0'
 }
 
 task obfuscate {

diff --git a/examples/annotation/build.xml b/examples/annotation/build.xml
@@ -1,7 +1,7 @@
 <project>
     <property name="projectDir" value="."/>
     <property name="libraryDir" value="lib"/>
-    <property name="version" value="3.1.0-SNAPSHOT"/>
+    <property name="version" value="4.0.0"/>
 
     <property name="project_name" value="HelloWorld"/>
     <property name="jar" value="build/jar/${project_name}.jar"/>

diff --git a/examples/annotation/pom.xml b/examples/annotation/pom.xml
@@ -16,13 +16,13 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>3.1.0-SNAPSHOT</version>
+      <version>4.0.0</version>
       <scope>compile</scope>
     </dependency>
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>annotation</artifactId>
-      <version>3.1.0-SNAPSHOT</version>
+      <version>4.0.0</version>
     </dependency>
   </dependencies>
   <build>

diff --git a/examples/application/build.gradle b/examples/application/build.gradle
@@ -21,7 +21,7 @@ repositories {
 }
 
 dependencies {
-  compile 'com.yworks:yguard:3.1.0-SNAPSHOT'
+  compile 'com.yworks:yguard:4.0.0'
 }
 
 task obfuscate {

diff --git a/examples/application/build.xml b/examples/application/build.xml
@@ -1,7 +1,7 @@
 <project>
     <property name="projectDir" value="."/>
     <property name="libraryDir" value="lib"/>
-    <property name="version" value="3.1.0-SNAPSHOT"/>
+    <property name="version" value="4.0.0"/>
 
     <property name="project_name" value="HelloWorld"/>
     <property name="jar" value="build/jar/${project_name}.jar"/>

diff --git a/examples/application/pom.xml b/examples/application/pom.xml
@@ -16,7 +16,7 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>3.1.0-SNAPSHOT</version>
+      <version>4.0.0</version>
       <scope>compile</scope>
     </dependency>
   </dependencies>

diff --git a/examples/external_library/build.gradle b/examples/external_library/build.gradle
@@ -30,7 +30,7 @@ configurations {
 }
 
 dependencies {
-  compile 'com.yworks:yguard:3.1.0-SNAPSHOT'
+  compile 'com.yworks:yguard:4.0.0'
   gson 'com.google.code.gson:gson:2.8.9'
   implementation configurations.gson.dependencies
 }

diff --git a/examples/external_library/build.xml b/examples/external_library/build.xml
@@ -1,7 +1,7 @@
 <project>
     <property name="projectDir" value="."/>
     <property name="libraryDir" value="lib"/>
-    <property name="version" value="3.1.0-SNAPSHOT"/>
+    <property name="version" value="4.0.0"/>
 
     <property name="project_name" value="HelloWorld"/>
     <property name="jar" value="build/jar/${project_name}.jar"/>

diff --git a/examples/external_library/pom.xml b/examples/external_library/pom.xml
@@ -16,7 +16,7 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>3.1.0-SNAPSHOT</version>
+      <version>4.0.0</version>
       <scope>compile</scope>
     </dependency>
     <!--  Gson: Java to Json conversion -->

diff --git a/examples/fxml/build.gradle b/examples/fxml/build.gradle
@@ -27,8 +27,8 @@ repositories {
 }
 
 dependencies {
-  compile 'com.yworks:yguard:3.1.0-SNAPSHOT'
-  compile 'com.yworks:annotation:3.1.0-SNAPSHOT'
+  compile 'com.yworks:yguard:4.0.0'
+  compile 'com.yworks:annotation:4.0.0'
 }
 
 task obfuscate {

diff --git a/examples/library/build.gradle b/examples/library/build.gradle
@@ -26,7 +26,7 @@ repositories {
 }
 
 dependencies {
-  compile 'com.yworks:yguard:3.1.0-SNAPSHOT'
+  compile 'com.yworks:yguard:4.0.0'
 }
 
 task obfuscate   {

diff --git a/examples/library/build.xml b/examples/library/build.xml
@@ -1,7 +1,7 @@
 <project>
     <property name="projectDir" value="."/>
     <property name="libraryDir" value="lib"/>
-    <property name="version" value="3.1.0-SNAPSHOT"/>
+    <property name="version" value="4.0.0"/>
 
     <property name="project_name" value="HelloWorld"/>
     <property name="jar" value="build/jar/${project_name}.jar"/>

diff --git a/examples/library/pom.xml b/examples/library/pom.xml
@@ -16,7 +16,7 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>3.1.0-SNAPSHOT</version>
+      <version>4.0.0</version>
       <scope>compile</scope>
     </dependency>
   </dependencies>

diff --git a/examples/processing/pom.xml b/examples/processing/pom.xml
@@ -25,7 +25,7 @@
 		<dependency>
 			<groupId>com.yworks</groupId>
 			<artifactId>yguard</artifactId>
-			<version>3.1.0-SNAPSHOT</version>
+			<version>4.0.0</version>
 			<!--
 			  prevent the spring boot plug-in from bundling yGuard and its
 			  dependencies into the project jar / project build artefact

diff --git a/examples/resources/build.gradle b/examples/resources/build.gradle
@@ -21,7 +21,7 @@ repositories {
 }
 
 dependencies {
-  compile 'com.yworks:yguard:3.1.0-SNAPSHOT'
+  compile 'com.yworks:yguard:4.0.0'
 }
 
 task obfuscate {

diff --git a/examples/resources/build.xml b/examples/resources/build.xml
@@ -1,7 +1,7 @@
 <project>
     <property name="projectDir" value="."/>
     <property name="libraryDir" value="lib"/>
-    <property name="version" value="3.1.0-SNAPSHOT"/>
+    <property name="version" value="4.0.0"/>
 
     <property name="project_name" value="HelloWorld"/>
     <property name="jar" value="build/jar/${project_name}.jar"/>

diff --git a/examples/resources/pom.xml b/examples/resources/pom.xml
@@ -16,7 +16,7 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>3.1.0-SNAPSHOT</version>
+      <version>4.0.0</version>
       <scope>compile</scope>
     </dependency>
   </dependencies>

diff --git a/examples/serializable_exclusion/build.gradle b/examples/serializable_exclusion/build.gradle
@@ -21,7 +21,7 @@ repositories {
 }
 
 dependencies {
-  compile 'com.yworks:yguard:3.1.0-SNAPSHOT'
+  compile 'com.yworks:yguard:4.0.0'
 }
 
 task obfuscate {

diff --git a/examples/serializable_exclusion/build.xml b/examples/serializable_exclusion/build.xml
@@ -1,7 +1,7 @@
 <project>
     <property name="projectDir" value="."/>
     <property name="libraryDir" value="lib"/>
-    <property name="version" value="3.1.0-SNAPSHOT"/>
+    <property name="version" value="4.0.0"/>
 
     <property name="project_name" value="HelloWorld"/>
     <property name="jar" value="build/jar/${project_name}.jar"/>

diff --git a/examples/serializable_exclusion/pom.xml b/examples/serializable_exclusion/pom.xml
@@ -16,7 +16,7 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>3.1.0-SNAPSHOT</version>
+      <version>4.0.0</version>
       <scope>compile</scope>
     </dependency>
   </dependencies>

diff --git a/gradle.properties b/gradle.properties
@@ -1,5 +1,5 @@
-VERSION_MAJOR=3.1
-VERSION_MINOR=0-SNAPSHOT
+VERSION_MAJOR=4.0
+VERSION_MINOR=0
 
 POM_DESCRIPTION=The open-source Java obfuscation tool working with Ant and Gradle by yWorks - the diagramming experts
 POM_URL=https://github.com/yWorks/yGuard