Merge pull request #5 from Bernardo-MG/release

Release
Bernardo-MG · Feb 21, 2021 · 3318241 · 3318241
2 parents fca8628 + 48cbd64
commit 3318241
Show file tree

Hide file tree

Showing 10 changed files with 154 additions and 72 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,32 @@
+name: Deployment
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Extract branch name
+      shell: bash
+      run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+      id: extract_branch
+    - name: Check-out
+      uses: actions/checkout@v2
+    - name: Set up JDK
+      uses: actions/setup-java@v1
+      with:
+        java-version: 1.8
+    - name: Set up Maven settings
+      uses: bernardo-mg/deployment-maven-settings-action@v1.1.2
+      with:
+        version-type: ${{ steps.extract_branch.outputs.branch }}
+      env:
+        DEPLOY_USER: ${{ secrets.DEPLOY_USER }}
+        DEPLOY_PASSWORD: ${{ secrets.DEPLOY_PASSWORD }}
+    - name: Deploy
+      run: mvn deploy -B -P deployment,deployment-release --settings settings.xml
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
@@ -0,0 +1,46 @@
+name: Doc deployment
+
+on:
+  push:
+    branches:
+      - develop
+      - master
+
+jobs:
+  deploy_docs:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Create SSH key
+      run: |
+        mkdir -p ~/.ssh/
+        ssh-keyscan -H docs.bernardomg.com >> ~/.ssh/known_hosts
+      shell: bash
+    - name: Extract branch name
+      shell: bash
+      run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+      id: extract_branch
+    - name: Check-out
+      uses: actions/checkout@v2
+    - name: Set up JDK
+      uses: actions/setup-java@v1
+      with:
+        java-version: 1.8
+    - name: Set up Maven settings
+      uses: bernardo-mg/deployment-maven-settings-action@v1.1.2
+      with:
+        version-type: ${{ steps.extract_branch.outputs.branch }}
+      env:
+        DEPLOY_DOCS_USER: ${{ secrets.DEPLOY_DOCS_USER }}
+        DEPLOY_DOCS_PASSWORD: ${{ secrets.DEPLOY_DOCS_PASSWORD }}
+        DEPLOY_DOCS_DEVELOP_USER: ${{ secrets.DEPLOY_DOCS_DEVELOP_USER }}
+        DEPLOY_DOCS_DEVELOP_PASSWORD: ${{ secrets.DEPLOY_DOCS_DEVELOP_PASSWORD }}
+        DEPLOY_DOCS_SITE: ${{ secrets.DEPLOY_DOCS_SITE }}
+        DEPLOY_DOCS_DEVELOP_SITE: ${{ secrets.DEPLOY_DOCS_DEVELOP_SITE }}
+    - name: Deploy development docs
+      if: steps.extract_branch.outputs.branch == 'develop'
+      run: mvn site site:deploy -B -P deployment,deployment-development --settings settings.xml
+    - name: Deploy release docs
+      if: steps.extract_branch.outputs.branch == 'master'
+      run: mvn site site:deploy -B -P deployment,deployment-release --settings settings.xml
diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -0,0 +1,21 @@
+name: Testing and validation
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        jdk: [ 8, 11, 14 ]
+
+    steps:
+    - name: Check-out
+      uses: actions/checkout@v2
+    - name: Set up JDK ${{ matrix.jdk }}
+      uses: actions/setup-java@v1
+      with:
+        java-version: ${{ matrix.jdk }}
+    - name: Run all tests
+      run: mvn clean verify
diff --git a/.travis.yml b/.travis.yml
diff --git a/pom.xml b/pom.xml
@@ -11,7 +11,7 @@
    <parent>
       <groupId>com.bernardomg.maven</groupId>
       <artifactId>base-pom</artifactId>
-      <version>1.2.4</version>
+      <version>1.4.0</version>
    </parent>
 
    <!-- ********************************************** -->
@@ -20,7 +20,7 @@
 
    <groupId>com.bernardomg.velocity</groupId>
    <artifactId>velocity-config-tool</artifactId>
-   <version>1.2.0</version>
+   <version>1.2.1</version>
    <packaging>jar</packaging>
 
    <name>Velocity config tool</name>
@@ -53,8 +53,8 @@
    </issueManagement>
 
    <ciManagement>
-      <system>Travis CI</system>
-      <url>https://travis-ci.org/Bernardo-MG/velocity-config-tool</url>
+      <system>Github Actions</system>
+      <url>https://github.com/Bernardo-MG/velocity-config-tool/actions</url>
       <notifiers />
    </ciManagement>
 
@@ -167,23 +167,22 @@
       <!-- ============================================== -->
       <!-- =========== DEPENDENCIES VERSIONS ============ -->
       <!-- ============================================== -->
-      <commons.beanUtils.version>1.9.3</commons.beanUtils.version>
+      <commons.beanUtils.version>1.9.4</commons.beanUtils.version>
       <commons.chain.version>1.2</commons.chain.version>
       <commons.collections.version>3.2.2</commons.collections.version>
       <commons.digester.version>2.1</commons.digester.version>
       <commons.logging.version>1.2</commons.logging.version>
-      <commons.validator.version>1.6</commons.validator.version>
-      <doxia.decoration.version>1.9.1</doxia.decoration.version>
-      <guava.version>28.0-jre</guava.version>
-      <junit.jupiter.version>5.5.0</junit.jupiter.version>
-      <junit.platform.version>1.5.0</junit.platform.version>
-      <mockito.version>2.28.2</mockito.version>
-      <plexus.version>3.2.0</plexus.version>
+      <commons.validator.version>1.7</commons.validator.version>
+      <doxia.decoration.version>1.9.2</doxia.decoration.version>
+      <guava.version>30.1-jre</guava.version>
+      <junit.jupiter.version>5.7.1</junit.jupiter.version>
+      <mockito.version>3.7.7</mockito.version>
+      <plexus.version>3.3.0</plexus.version>
       <velocity.tools.version>2.0</velocity.tools.version>
       <!-- ============================================== -->
       <!-- ================= MAVEN SITE ================= -->
       <!-- ============================================== -->
-      <site.skin.version>1.4.1</site.skin.version>
+      <site.skin.version>2.0.11</site.skin.version>
       <bintrayURL>https://bintray.com/bernardo-mg/maven/velocity-config-tool/view</bintrayURL>
       <mavenURL>http://mvnrepository.com/artifact/com.bernardomg.velocity/velocity-config-tool</mavenURL>
    </properties>
@@ -192,6 +191,19 @@
    <!-- *************** DEPENDENCIES ***************** -->
    <!-- ********************************************** -->
 
+   <dependencyManagement>
+      <dependencies>
+         <dependency>
+            <!-- JUnit BOM -->
+            <groupId>org.junit</groupId>
+            <artifactId>junit-bom</artifactId>
+            <version>${junit.jupiter.version}</version>
+            <type>pom</type>
+            <scope>import</scope>
+         </dependency>
+      </dependencies>
+   </dependencyManagement>
+
    <dependencies>
       <dependency>
          <!-- Doxia Decoration Model -->
@@ -280,14 +292,12 @@
          <!-- JUnit Jupiter Engine -->
          <groupId>org.junit.jupiter</groupId>
          <artifactId>junit-jupiter-engine</artifactId>
-         <version>${junit.jupiter.version}</version>
          <scope>test</scope>
       </dependency>
       <dependency>
          <!-- JUnit Jupiter Platform -->
          <groupId>org.junit.platform</groupId>
          <artifactId>junit-platform-runner</artifactId>
-         <version>${junit.platform.version}</version>
          <scope>test</scope>
       </dependency>
       <dependency>
@@ -369,7 +379,7 @@
          </plugin>
          <plugin>
             <!-- Javadoc -->
-            <!-- Generates the Javadocs. -->
+            <!-- Generates the Javadocs -->
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-javadoc-plugin</artifactId>
             <configuration>
@@ -381,9 +391,7 @@
          </plugin>
          <plugin>
             <!-- PMD -->
-            <!-- Checks that the code complies with a series of code quality 
-               rules -->
-            <!-- It is using a customized rules file -->
+            <!-- Checks that the code complies with a series of code quality rules -->
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-pmd-plugin</artifactId>
             <configuration>

diff --git a/readme.md b/readme.md
@@ -127,9 +127,9 @@ The project has been released under the [MIT License][license].
 [bintray-repo]: https://bintray.com/bernardo-mg/maven/velocity-config-tool/view
 [maven-repo]: http://mvnrepository.com/artifact/com.bernardomg.velocity/velocity-config-tool
 [issues]: https://github.com/bernardo-mg/velocity-config-tool/issues
-[javadoc-develop]: http://docs.bernardomg.com/development/maven/velocity-config-tool/apidocs
-[javadoc-release]: http://docs.bernardomg.com/maven/velocity-config-tool/apidocs
+[javadoc-develop]: https://docs.bernardomg.com/development/maven/velocity-config-tool/apidocs
+[javadoc-release]: https://docs.bernardomg.com/maven/velocity-config-tool/apidocs
 [license]: http://www.opensource.org/licenses/mit-license.php
 [scm]: https://github.com/bernardo-mg/velocity-config-tool
-[site-develop]: http://docs.bernardomg.com/development/maven/velocity-config-tool
-[site-release]: http://docs.bernardomg.com/maven/velocity-config-tool
+[site-develop]: https://docs.bernardomg.com/development/maven/velocity-config-tool
+[site-release]: https://docs.bernardomg.com/maven/velocity-config-tool
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -31,5 +31,10 @@
             Dropped JDK7 support
          </action>
       </release>
+      <release version="1.2.1" date="2021-02-21" 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
@@ -38,6 +38,12 @@
       <property name="eachLine" value="true" />
    </module>
 
+   <!-- Checks line lenght -->
+   <module name="LineLength">
+      <property name="max" value="100" />
+      <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://" />
+   </module>
+
    <module name="TreeWalker">
 
       <!-- Checks for Javadoc comments -->
@@ -47,35 +53,25 @@
       <module name="JavadocStyle" />
       <module name="AtclauseOrder">
          <property name="tagOrder" value="@param, @return, @throws, @deprecated" />
-         <property name="target"
-            value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
+         <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
       </module>
       <module name="NonEmptyAtclauseDescription" />
       <module name="SummaryJavadocCheck" />
       <!-- Not yet supported -->
-      <!--<module name="JavadocParagraph"> <property name="allowNewlineParagraph" 
-         value="true" /> </module> -->
+      <!--<module name="JavadocParagraph"> <property name="allowNewlineParagraph" value="true" /> </module> -->
       <module name="CommentsIndentation" />
 
       <!-- Checks for texts -->
       <module name="IllegalTokenText">
          <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL" />
-         <property name="format"
-            value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)" />
-         <property name="message"
-            value="Avoid using corresponding octal or Unicode escape." />
+         <property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)" />
+         <property name="message" value="Avoid using corresponding octal or Unicode escape." />
       </module>
       <module name="AvoidEscapedUnicodeCharacters">
-         <property name="allowEscapesForControlCharacters"
-            value="true" />
+         <property name="allowEscapesForControlCharacters" value="true" />
          <property name="allowByTailComment" value="true" />
          <property name="allowNonPrintableEscapes" value="true" />
       </module>
-      <module name="LineLength">
-         <property name="max" value="100" />
-         <property name="ignorePattern"
-            value="^package.*|^import.*|a href|href|http://|https://|ftp://" />
-      </module>
 
       <!-- Checks for Naming Conventions -->
       <module name="ConstantName" />
@@ -124,8 +120,7 @@
       <!-- Modifier Checks -->
       <module name="ModifierOrder" />
       <module name="RedundantModifier">
-         <property name="tokens"
-            value="VARIABLE_DEF, ANNOTATION_FIELD_DEF, INTERFACE_DEF" />
+         <property name="tokens" value="VARIABLE_DEF, ANNOTATION_FIELD_DEF, INTERFACE_DEF" />
       </module>
 
       <!-- Checks for {} blocks -->
@@ -169,7 +164,10 @@
       <module name="EmptyLineSeparator">
          <property name="allowNoEmptyLineBetweenFields" value="true" />
       </module>
-      <module name="SeparatorWrap" />
+      <module name="SeparatorWrap">
+         <property name="tokens" value="DOT" />
+         <property name="option" value="nl" />
+      </module>
       <module name="AnnotationLocation" />
 
    </module>

diff --git a/src/config/pmd/pmd-rules.xml b/src/config/pmd/pmd-rules.xml
@@ -12,6 +12,7 @@
       <exclude name="AvoidFinalLocalVariable" />
       <exclude name="UnnecessaryConstructor" />
       <exclude name="UnnecessaryModifier" />
+      <exclude name="UselessParentheses" />
    </rule>
    <rule ref="category/java/design.xml">
       <exclude name="DataClass" />

diff --git a/src/site/markdown/reports.md b/src/site/markdown/reports.md
@@ -13,7 +13,7 @@
 |Report|Description|
 |---|---|
 |[Checkstyle][checkstyle]|Report on coding style conventions.|
-|[FindBugs][findbugs]|Generates a source code report with the FindBugs Library.|
+|[SpotBugs][spotbugs]|Generates a source code report with the SpotBugs Library.|
 |[PMD][pmd]|Verification of coding rules.|
 |[CPD][cpd]|Duplicate code detection.|
 |[JDepend][jdepend]|Quality metrics for the project.|
@@ -40,11 +40,11 @@
 [dependencies]: ./dependencies.html
 [dependency-analysis]: ./dependency-analysis.html
 [failsafe]: ./failsafe-report.html
-[findbugs]: ./findbugs.html
 [jacoco]: ./jacoco/index.html
 [jdepend]: ./jdepend-report.html
 [pmd]: ./pmd.html
 [plugins]: ./plugins.html
 [plugins-manage]: ./plugin-management.html
+[spotbugs]: ./spotbugs.html
 [surefire]: ./surefire-report.html
 [taglist]: ./taglist.html