v1.3.2

Bernardo-MG · Sep 9, 2024 · 225db06 · 225db06
2 parents 3e219f8 + c2a6f19
commit 225db06
Show file tree

Hide file tree

Showing 26 changed files with 136 additions and 126 deletions.
diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml
@@ -6,16 +6,36 @@ on:
 
 jobs:
   github:
-    name: Github
-    uses: Bernardo-MG/github-workflow/.github/workflows/maven_deploy_github.yml@v1
-    secrets:
-      token: ${{ secrets.GITHUB_TOKEN }}
+    name: Github deployment
+    runs-on: ubuntu-latest
+    concurrency:
+      group: deploy-github-${{ github.ref }}
+      cancel-in-progress: true
+    permissions: 
+      contents: read
+      packages: write
+
+    steps:
+    - name: Deploy to Github
+      uses: bernardo-mg/maven-github-deployment-action@v1
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        jdk: 17
 
   ossrh:
-    name: OSSRH
-    uses: Bernardo-MG/github-workflow/.github/workflows/maven_deploy_signed.yml@v1
-    secrets:
-      username: ${{ secrets.OSSRH_USERNAME }}
-      password: ${{ secrets.OSSRH_TOKEN }}
-      gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
-      gpg-passphrase: ${{ secrets.GPG_PASSPHRASE }}
+    name: OSSRH deployment
+    runs-on: ubuntu-latest
+    environment: deployment_ossrh
+    concurrency:
+      group: deploy-ossrh-${{ github.ref }}
+      cancel-in-progress: true
+
+    steps:
+    - name: Deploy
+      uses: bernardo-mg/maven-signed-deployment-action@v1
+      with:
+        username: ${{ secrets.OSSRH_USERNAME }}
+        password: ${{ secrets.OSSRH_TOKEN }}
+        gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
+        gpg-passphrase: ${{ secrets.GPG_PASSPHRASE }}
+        jdk: 17
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,32 +1,26 @@
-name: Tests and docs
+name: Tests
 
 on: [push, pull_request]
 
 jobs:
   tests:
-    name: Tests
-    uses: Bernardo-MG/github-workflow/.github/workflows/maven_testing.yml@v1
+    name: Tests with JDK ${{ matrix.jdk }}
+    runs-on: ubuntu-latest
 
-  deploy_develop_docs:
-    name: Deploy development docs
-    needs: tests
-    uses: Bernardo-MG/github-workflow/.github/workflows/maven_deploy_site.yml@v1
-    with:
-      branch: develop
-      host: docs.bernardomg.com
-    secrets:
-      url: ${{ secrets.DEPLOY_DOCS_DEVELOP_SITE }}
-      username: ${{ secrets.DEPLOY_DOCS_DEVELOP_USER }}
-      password: ${{ secrets.DEPLOY_DOCS_DEVELOP_PASSWORD }}
+    strategy:
+      matrix:
+        jdk: [17, 21]
 
-  deploy_docs:
-    name: Deploy docs
-    needs: tests
-    uses: Bernardo-MG/github-workflow/.github/workflows/maven_deploy_site.yml@v1
-    with:
-      branch: master
-      host: docs.bernardomg.com
-    secrets:
-      url: ${{ secrets.DEPLOY_DOCS_SITE }}
-      username: ${{ secrets.DEPLOY_DOCS_USER }}
-      password: ${{ secrets.DEPLOY_DOCS_PASSWORD }}
+    steps:
+    - name: Check-out
+      uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up JDK ${{ matrix.jdk }}
+      uses: actions/setup-java@v4
+      with:
+        java-version: ${{ matrix.jdk }}
+        distribution: 'temurin'
+        cache: 'maven'
+    - name: Run up to integration tests
+      run: mvn verify -fae
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2021 Bernardo Martínez Garrido
+Copyright (c) 2015-2023 Bernardo Martínez Garrido
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/pom.xml b/pom.xml
@@ -11,7 +11,7 @@
    <parent>
       <groupId>com.bernardomg.maven</groupId>
       <artifactId>base-pom</artifactId>
-      <version>1.5.3</version>
+      <version>1.5.4</version>
    </parent>
 
    <!-- ********************************************** -->
@@ -20,7 +20,7 @@
 
    <groupId>com.bernardomg.velocity</groupId>
    <artifactId>maven-site-fixer</artifactId>
-   <version>1.3.1</version>
+   <version>1.3.2</version>
    <packaging>jar</packaging>
 
    <name>Maven Site Fixer</name>
@@ -185,15 +185,20 @@
       <!-- =========== DEPENDENCIES VERSIONS ============ -->
       <!-- ============================================== -->
       <commons.beanUtils.version>1.9.4</commons.beanUtils.version>
-      <commons.lang3.version>3.11</commons.lang3.version>
-      <commons.logging.version>1.2</commons.logging.version>
-      <jsoup.version>1.15.3</jsoup.version>
-      <junit.jupiter.version>5.9.2</junit.jupiter.version>
+      <commons.lang3.version>3.17.0</commons.lang3.version>
+      <commons.logging.version>1.3.4</commons.logging.version>
+      <jsoup.version>1.18.1</jsoup.version>
+      <junit.jupiter.version>5.11.0</junit.jupiter.version>
       <velocity.tools.version>3.1</velocity.tools.version>
       <!-- ============================================== -->
+      <!-- ============ PLUGIN CONFIGURATION ============ -->
+      <!-- ============================================== -->
+      <!-- Checkstyle customized rules file -->
+      <checkstyle.config.location>${project.basedir}/src/config/checkstyle/checkstyle-rules.xml</checkstyle.config.location>
+      <!-- ============================================== -->
       <!-- ================= MAVEN SITE ================= -->
       <!-- ============================================== -->
-      <site.skin.version>2.3.1</site.skin.version>
+      <site.skin.version>2.3.2</site.skin.version>
       <mavenURL>http://mvnrepository.com/artifact/com.bernardomg.velocity/maven-site-fixer</mavenURL>
       <githubArtifactURL><![CDATA[https://github.com/Bernardo-MG?tab=packages&amp;repo_name=maven-site-fixer]]></githubArtifactURL>
    </properties>
@@ -325,40 +330,33 @@
 
    <reporting>
       <plugins>
-         <plugin>
-            <!-- Checkstyle -->
-            <!-- Checks that the source files comply with style standards -->
-            <!-- It is using a customized rules file -->
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-checkstyle-plugin</artifactId>
-            <configuration>
-               <!-- The customized rules file -->
-               <configLocation>${project.basedir}/src/config/checkstyle/checkstyle-rules.xml</configLocation>
-            </configuration>
-         </plugin>
          <plugin>
             <!-- Javadoc -->
-            <!-- Generates the Javadocs. -->
+            <!-- Generates the javadocs -->
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-javadoc-plugin</artifactId>
             <configuration>
                <links>
-                  <link>https://velocity.apache.org/tools/devel/apidocs/</link>
-                  <link>https://jsoup.org/apidocs/</link>
+                  <link>http://www.antlr.org/api/Java/</link>
                </links>
+               <!-- Excludes generated code -->
+               <excludePackageNames>*.generated.*</excludePackageNames>
             </configuration>
          </plugin>
          <plugin>
             <!-- PMD -->
             <!-- Checks that the code complies with a series of code quality rules -->
-            <!-- It is using a customized rules file -->
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-pmd-plugin</artifactId>
             <configuration>
                <rulesets>
                   <!-- The customized rules file -->
                   <ruleset>${project.basedir}/src/config/pmd/pmd-rules.xml</ruleset>
                </rulesets>
+               <excludes>
+                  <!-- Excludes generated code -->
+                  <exclude>**/generated/**/*</exclude>
+               </excludes>
             </configuration>
          </plugin>
       </plugins>

diff --git a/readme.md b/readme.md
@@ -44,12 +44,6 @@ The tools included in this project will transform that example into this:
 
 [![Maven Central](https://img.shields.io/maven-central/v/com.bernardomg.velocity/maven-site-fixer.svg)][maven-repo]
 
-[![Release docs](https://img.shields.io/badge/docs-release-blue.svg)][site-release]
-[![Development docs](https://img.shields.io/badge/docs-develop-blue.svg)][site-develop]
-
-[![Release javadocs](https://img.shields.io/badge/javadocs-release-blue.svg)][javadoc-release]
-[![Development javadocs](https://img.shields.io/badge/javadocs-develop-blue.svg)][javadoc-develop]
-
 ## Features
 
 The project is composed by a small set of tools which allow editing the content of a Maven site page
@@ -63,26 +57,6 @@ The project is composed by a small set of tools which allow editing the content
 
 The tools were developed to be used by the [Docs Maven Skin][docs-skin].
 
-## Documentation
-
-Documentation is always generated for the latest release, kept in the 'master' branch:
-
-- The [latest release documentation page][site-release].
-- The [the latest release Javadoc site][javadoc-release].
-
-Documentation is also generated from the latest snapshot, taken from the 'develop' branch:
-
-- The [the latest snapshot documentation page][site-develop].
-- The [the latest snapshot Javadoc site][javadoc-develop].
-
-The documentation site sources come along the source code (as it is a Maven site), so it is always possible to generate them using the following Maven command:
-
-```
-$ mvn verify site
-```
-
-The verify phase is required, as otherwise some of the reports won't be created.
-
 ## Acknowledgement
 
 The code comes from adapting the tools at the [Reflow Maven Skin][reflow-skin]. They were made their own project, instead of being part of a multi-module Maven project, and then heavily modified.
@@ -144,9 +118,5 @@ The project has been released under the [MIT License][license].
 
 [maven-repo]: http://mvnrepository.com/artifact/com.bernardomg.velocity/maven-site-fixer
 [issues]: https://github.com/bernardo-mg/maven-site-fixer/issues
-[javadoc-develop]: https://docs.bernardomg.com/development/maven/maven-site-fixer/apidocs
-[javadoc-release]: https://docs.bernardomg.com/maven/maven-site-fixer/apidocs
 [license]: http://www.opensource.org/licenses/mit-license.php
 [scm]: https://github.com/bernardo-mg/maven-site-fixer
-[site-develop]: https://docs.bernardomg.com/development/maven/maven-site-fixer
-[site-release]: https://docs.bernardomg.com/maven/maven-site-fixer
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -121,5 +121,10 @@
             Updated JDK compatibility level.
          </action>
       </release>
+      <release version="1.3.2" date="2024-09-09" description="Updated dependencies">
+         <action dev="bmg" type="update">
+            Updated dependencies.
+         </action>
+      </release>
    </body>
 </document>
diff --git a/src/config/checkstyle/checkstyle-rules.xml b/src/config/checkstyle/checkstyle-rules.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!DOCTYPE module PUBLIC
-          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
-          "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+          "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+          "https://checkstyle.org/dtds/configuration_1_3.dtd">
 
 <!-- Checkstyle for running a checks suite based on Sun's Java style conventions -->
 

diff --git a/src/main/java/com/bernardomg/velocity/tool/Html5UpdateTool.java b/src/main/java/com/bernardomg/velocity/tool/Html5UpdateTool.java
@@ -1,7 +1,7 @@
 /**
  * The MIT License (MIT)
  * <p>
- * Copyright (c) 2015-2021 the original author or authors.
+ * Copyright (c) 2015-2023 the original author or authors.
  * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/com/bernardomg/velocity/tool/HtmlTool.java b/src/main/java/com/bernardomg/velocity/tool/HtmlTool.java
@@ -1,7 +1,7 @@
 /**
  * The MIT License (MIT)
  * <p>
- * Copyright (c) 2015-2021 the original author or authors.
+ * Copyright (c) 2015-2023 the original author or authors.
  * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/com/bernardomg/velocity/tool/SiteTool.java b/src/main/java/com/bernardomg/velocity/tool/SiteTool.java
@@ -1,7 +1,7 @@
 /**
  * The MIT License (MIT)
  * <p>
- * Copyright (c) 2015-2021 the original author or authors.
+ * Copyright (c) 2015-2023 the original author or authors.
  * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/com/bernardomg/velocity/tool/package-info.java b/src/main/java/com/bernardomg/velocity/tool/package-info.java
@@ -1,7 +1,7 @@
 /**
  * The MIT License (MIT)
  * <p>
- * Copyright (c) 2015-2021 the original author or authors.
+ * Copyright (c) 2015-2023 the original author or authors.
  * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/test/java/com/bernardomg/velocity/tool/test/unit/html/TestHtmlToolAddClass.java b/src/test/java/com/bernardomg/velocity/tool/test/unit/html/TestHtmlToolAddClass.java
@@ -1,7 +1,7 @@
 /**
  * The MIT License (MIT)
  * <p>
- * Copyright (c) 2015-2021 the original author or authors.
+ * Copyright (c) 2015-2023 the original author or authors.
  * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/test/java/com/bernardomg/velocity/tool/test/unit/html/TestHtmlToolRemoveAttribute.java b/src/test/java/com/bernardomg/velocity/tool/test/unit/html/TestHtmlToolRemoveAttribute.java
@@ -1,7 +1,7 @@
 /**
  * The MIT License (MIT)
  * <p>
- * Copyright (c) 2015-2021 the original author or authors.
+ * Copyright (c) 2015-2023 the original author or authors.
  * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/test/java/com/bernardomg/velocity/tool/test/unit/html/TestHtmlToolRemoveClass.java b/src/test/java/com/bernardomg/velocity/tool/test/unit/html/TestHtmlToolRemoveClass.java
@@ -1,7 +1,7 @@
 /**
  * The MIT License (MIT)
  * <p>
- * Copyright (c) 2015-2021 the original author or authors.
+ * Copyright (c) 2015-2023 the original author or authors.
  * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/test/java/com/bernardomg/velocity/tool/test/unit/html/TestHtmlToolRetag.java b/src/test/java/com/bernardomg/velocity/tool/test/unit/html/TestHtmlToolRetag.java
@@ -1,7 +1,7 @@
 /**
  * The MIT License (MIT)
  * <p>
- * Copyright (c) 2015-2021 the original author or authors.
+ * Copyright (c) 2015-2023 the original author or authors.
  * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/test/java/com/bernardomg/velocity/tool/test/unit/html/TestHtmlToolSwapTagWithParent.java b/src/test/java/com/bernardomg/velocity/tool/test/unit/html/TestHtmlToolSwapTagWithParent.java
@@ -1,7 +1,7 @@
 /**
  * The MIT License (MIT)
  * <p>
- * Copyright (c) 2015-2021 the original author or authors.
+ * Copyright (c) 2015-2023 the original author or authors.
  * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal