Merge pull request #68 from olyutorskii/release/v2.101.14

Release/v2.101.14

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Runtime information**
+JDK version is important.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Unit tests**
+Welcome to disclose failed unit tests(JUnit4).
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the feature request here.

.github/workflows/codeql-analysis.yml

@@ -14,34 +14,40 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ develop ]
+    branches: [ main ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ develop ]
+    branches: [ main ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
   schedule:
     # https://crontab.guru/
-    - cron: '25 8 11 * *'
+    - cron: '27 10 13 * *'
 
 jobs:
   analyze:
     name: Analyze
     runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
 
     strategy:
       fail-fast: false
       matrix:
         language: [ 'java' ]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more...
-        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+        # https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2.3.4
+      uses: actions/checkout@v3.1.0
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -52,10 +58,10 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+    # 📚 https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
     # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
     #    and modify them (or add more) to build your code if your project
@@ -66,7 +72,7 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2
 
 
 ### EOF ###

.github/workflows/maven.yml

@@ -1,32 +1,35 @@
 # This workflow will build a Java project with Maven
-# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
 
 name: Java CI with Maven
 
 on:
   push:
-    branches: [ develop ]
+    branches: [ develop, release/** ]
   pull_request:
-    branches: [ develop ]
+    branches: [ main, develop ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 jobs:
+
   build:
 
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        java: [ 8, 11, 16 ]
-    name: Java ${{ matrix.java }} sample
+        java: [ 8, 11, 17 ]
+    name: Java ${{ matrix.java }} building
     steps:
-    - uses: actions/checkout@v2.3.4
+    - uses: actions/checkout@v3.1.0
     - name: Set up JDK
-      uses: actions/setup-java@v2
+      uses: actions/setup-java@v3
       with:
         distribution: 'adopt'
         java-version: ${{ matrix.java }}
     - name: Cache Maven packages
-      uses: actions/cache@v2.1.5
+      uses: actions/cache@v3
       with:
         path: ~/.m2
         key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
@@ -35,4 +38,29 @@ jobs:
       run: mvn --show-version -B package --file pom.xml
 
 
+  buildSite:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        java: [ 11, 17 ]
+    name: Java ${{ matrix.java }} siting
+    steps:
+    - uses: actions/[email protected]
+    - name: Set up JDK
+      uses: actions/setup-java@v3
+      with:
+        distribution: 'adopt'
+        java-version: ${{ matrix.java }}
+    - name: Cache Maven packages
+      uses: actions/cache@v3
+      with:
+        path: ~/.m2
+        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+        restore-keys: ${{ runner.os }}-m2
+    - name: Build with Maven
+      run: mvn --show-version -B site --file pom.xml
+
+
 ### EOF ###

.github/workflows/pages.yml

@@ -0,0 +1,62 @@
+# Workflow for Maven-report content (including Javadoc API) to GitHub Pages
+name: Deploy Maven-report to Pages
+
+on:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+
+  build:
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+
+      - name: Set up JDK
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'adopt'
+          java-version: 17
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+
+      - name: Cache Maven packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+
+      - name: Build document with Maven
+        run: mvn --show-version -B site --file pom.xml
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          # Upload Maven-report repository
+          path: './target/site/'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
+
+### EOF ###

.gitignore

@@ -1,4 +1,8 @@
-##### Git ignore pattern   https://git-scm.com/docs/gitignore
+##### Git ignore pattern
+## See https://git-scm.com/docs/gitignore
+## See https://docs.github.com/en/free-pro-team@latest/github/using-git/ignoring-files
+## See https://github.com/github/gitignore
+## See https://www.toptal.com/developers/gitignore
 
 
 ### Unix
@@ -20,7 +24,8 @@ __MACOSX
 ### Windows
 
 Thumbs.db
-desktop.ini
+[Dd]esktop.ini
+*.lnk
 
 
 ### JDK
@@ -64,4 +69,9 @@ hs_err_pid*
 *.ipr
 
 
+### Visual Studio Code
+
+/.vscode/
+
+
 ### EOF ###

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+
+## [2.101.14] - 2022-10-11
+
+### Added
+- Add Javadoc API publishing workflow for GitHub Actions.
+- Add manual trigger for GitHub Actions.
+
+### Changed
+- Modify JavaCI actions trigger for GitHub Actions.
+- Workaround MJAVADOC-700 issue.
+
+
 ## [2.101.12] - 2021-05-12
 
 ### Added
@@ -105,7 +117,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial Release
 
 
-[Unreleased]: https://github.com/olyutorskii/DoubDabC/compare/v2.101.12...HEAD
+[Unreleased]: https://github.com/olyutorskii/DoubDabC/compare/v2.101.14...HEAD
+[2.101.14]: https://github.com/olyutorskii/DoubDabC/compare/v2.101.12...v2.101.14
 [2.101.12]: https://github.com/olyutorskii/DoubDabC/compare/v2.101.10...v2.101.12
 [2.101.10]: https://github.com/olyutorskii/DoubDabC/compare/v2.101.8...v2.101.10
 [2.101.8]: https://github.com/olyutorskii/DoubDabC/compare/v2.101.6...v2.101.8

config/checkstyle/checkstyle.xml

@@ -6,7 +6,7 @@
 
 <!--
     Checkstyle modules
-    for Checkstyle 8.40 or later
+    for Checkstyle 8.45 or later
 
     [ https://checkstyle.org/ ]
 
@@ -81,7 +81,7 @@
     <module name="FileLength" />
     <module name="LineLength">
         <property name="fileExtensions" value="java" />
-        <property name="max" value="100" />
+        <property name="max" value="128" />
     </module>
 
 
@@ -211,6 +211,7 @@
         <module name="UnnecessarySemicolonAfterTypeMemberDeclaration" />
         <module name="UnnecessarySemicolonInEnumeration" />
         <module name="UnnecessarySemicolonInTryWithResources" />
+        <module name="UnusedLocalVariable" />
         <module name="VariableDeclarationUsageDistance" />
 
 
@@ -368,6 +369,7 @@
         <module name="NoWhitespaceBefore">
             <property name="allowLineBreaks" value="true" />
         </module>
+        <module name="NoWhitespaceBeforeCaseDefaultColon" />
         <module name="OperatorWrap" />
         <module name="ParenPad" />
         <module name="SeparatorWrap" />

config/pmd/pmdrules.xml

@@ -23,14 +23,14 @@
 
     <rule ref="category/java/codestyle.xml" >
         <exclude name="CommentDefaultAccessModifier" />
-        <exclude name="DefaultPackage" />
         <exclude name="LocalVariableCouldBeFinal" />
         <exclude name="MethodArgumentCouldBeFinal" />
         <exclude name="OnlyOneReturn" />
         <exclude name="ShortVariable" />
         <exclude name="UnnecessaryLocalBeforeReturn" />
         <exclude name="UnnecessaryModifier" />
         <exclude name="UnnecessaryReturn" />
+        <exclude name="UseUnderscoresInNumericLiterals" />
     </rule>
     <rule ref="category/java/codestyle.xml/ControlStatementBraces" >
         <properties>