image problems are solved

Author: ucoruh

.github/workflows/release.yml

@@ -53,8 +53,17 @@ jobs:
         run: sudo apt-get install -y libxml2-utils
         shell: bash
 
-      - name: Perform Maven clean, test, site generation, and packaging
-        run: mvn clean test site package
+      - name: Perform Maven clean, test, and packaging
+        run: mvn clean test package
+        working-directory: ./calculator-app
+
+      - name: Generate Folders
+        run: |
+            currentDir=$(pwd)
+            mkdir -p $currentDir/target/site/assets
+            mkdir -p $currentDir/target/site/coverxygen
+            mkdir -p $currentDir/target/site/doxygen
+            mkdir -p $currentDir/target/site/coveragereport
         working-directory: ./calculator-app
 
       - name: Check Test Coverage
@@ -76,7 +85,6 @@ jobs:
           echo "Missed: $missed"
         working-directory: ./calculator-app
 
-
       - name: Install ReportGenerator
         run: dotnet tool install -g dotnet-reportgenerator-globaltool
 
@@ -85,7 +93,9 @@ jobs:
         shell: bash
 
       - name: Generate ReportGenerator HTML Report
-        run: reportgenerator "-reports:target/site/jacoco/jacoco.xml" "-sourcedirs:src/main/java" "-targetdir:target/site/coveragereport" -reporttypes:Html
+        run: | 
+          reportgenerator "-reports:target/site/jacoco/jacoco.xml" "-sourcedirs:src/main/java" "-targetdir:target/site/coveragereport" -reporttypes:Html
+          reportgenerator "-reports:target/site/jacoco/jacoco.xml" "-sourcedirs:src/main/java" "-targetdir:target/site/coveragereport" -reporttypes:Badges
         working-directory: ./calculator-app
 
       - name: Run Coverxygen
@@ -95,7 +105,23 @@ jobs:
             python -m coverxygen --xml-dir $currentDir/calculator-app/target/site/doxygen/xml --src-dir $currentDir --format lcov --output $currentDir/calculator-app/target/site/coverxygen/lcov.info --prefix $currentDir/calculator-app/
         
       - name: Run genhtml
-        run: genhtml ./calculator-app/target/site/coverxygen/lcov.info -o calculator-app/target/site/coverxygen
+        run: genhtml ./calculator-app/target/site/coverxygen/lcov.info --legend --title "Documentation Coverage Report" -o calculator-app/target/site/coverxygen
+
+      - name: Copy Folders
+        run: |
+            cp "calculator-app/target/site/coveragereport/badge_combined.svg" "assets/badge_combined.svg"
+            cp "calculator-app/target/site/coveragereport/badge_combined.svg" "assets/badge_combined.svg"
+            cp "calculator-app/target/site/coveragereport/badge_branchcoverage.svg" "assets/badge_branchcoverage.svg"
+            cp "calculator-app/target/site/coveragereport/badge_linecoverage.svg" "assets/badge_linecoverage.svg"
+            cp "calculator-app/target/site/coveragereport/badge_methodcoverage.svg" "assets/badge_methodcoverage.svg"    
+            cp "assets/rteu_logo.jpg" "calculator-app/src/site/resources/images/rteu_logo.jpg"
+            cp README.md "calculator-app/src/site/markdown/readme.md"
+            cp -r ./assets/ ./calculator-app/src/site/resources
+        shell: bash
+
+      - name: Perform Maven site generation
+        run: mvn site
+        working-directory: ./calculator-app
 
       #- name: Archive Coverage Report
       #  uses: actions/upload-artifact@v2

.gitignore

@@ -959,3 +959,8 @@ coverage*[.json, .xml, .info]
 # Additional files built by Visual Studio
 
 # End of https://www.toptal.com/developers/gitignore/api/c,csharp,vs,visualstudio,visualstudiocode,java,maven,c++,cmake,eclipse,netbeans
+
+/calculator-app/src/site/markdown/readme.md
+/calculator-app/src/site/resources/assets/.gitkeep
+/calculator-app/src/site/resources/assets
+/calculator-app/src/site/resources/images/rteu_logo.jpg

7-build-app.bat

@@ -9,15 +9,37 @@ set "currentDir=%CD%"
 echo Change the current working directory to the script directory
 @cd /d "%~dp0"
 
+echo Delete the "docs" folder and its contents
+rd /S /Q "calculator-app/target/site/coverxygen"
+rd /S /Q "calculator-app/target/site/coveragereport"
+rd /S /Q "calculator-app/target/site/doxygen"
+
+echo Delete and Create the "release" folder and its contents
+rd /S /Q "release"
+mkdir release
+
 echo Change directory to calculator-app
 cd calculator-app
 
-echo Perform Maven clean, test, site generation, and packaging
-call mvn clean test site package
+echo Perform Maven clean, test, and packaging
+call mvn clean test package
 
 echo Return to the previous directory
 cd ..
 
+echo Create Required Folders coverxygen/coveragereport/doxygen
+cd calculator-app
+mkdir target
+cd target
+mkdir site
+cd site
+mkdir coverxygen
+mkdir coveragereport
+mkdir doxygen
+cd ..
+cd ..
+cd ..
+
 echo Generate Doxygen HTML and XML Documentation
 call doxygen Doxyfile
 
@@ -36,46 +58,51 @@ echo Our Binary is a Single Jar With Dependencies. You Do Not Need to Compress I
 echo Return to the previous directory
 cd ..
 
+echo Run Coverxygen
+call python -m coverxygen --xml-dir ./calculator-app/target/site/doxygen/xml --src-dir ./ --format lcov --output ./calculator-app/target/site/coverxygen/lcov.info --prefix %currentDir%\calculator-app\
+
+echo Run lcov genhtml
+call perl C:\ProgramData\chocolatey\lib\lcov\tools\bin\genhtml ./calculator-app\target\site\coverxygen\lcov.info --legend --title "Documentation Coverage Report" -o calculator-app/target/site/coverxygen
+
+echo Copy badge files to the "assets" directory
+call copy "calculator-app\target\site\coveragereport\badge_combined.svg" "assets\badge_combined.svg"
+call copy "calculator-app\target\site\coveragereport\badge_combined.svg" "assets\badge_combined.svg"
+call copy "calculator-app\target\site\coveragereport\badge_branchcoverage.svg" "assets\badge_branchcoverage.svg"
+call copy "calculator-app\target\site\coveragereport\badge_linecoverage.svg" "assets\badge_linecoverage.svg"
+call copy "calculator-app\target\site\coveragereport\badge_methodcoverage.svg" "assets\badge_methodcoverage.svg"
+
+call copy "assets\rteu_logo.jpg" "calculator-app\src\site\resources\images\rteu_logo.jpg"
 
-echo Generate Doxygen Coverage Report
+echo Copy the "assets" folder and its contents to "maven site images" recursively
+call robocopy assets "calculator-app\src\site\resources\assets" /E
+
+echo Copy the "README.md" file to "calculator-app/src/site/markdown/readme.md"
+call copy README.md "calculator-app\src\site\markdown\readme.md"
 
-echo Create coverxygen directory
 cd calculator-app
-cd target
-cd site
-mkdir coverxygen
-cd ..
-cd ..
+echo Perform Maven site generation
+call mvn site
 cd ..
 
-echo Run Coverxygen
-call python -m coverxygen --xml-dir ./calculator-app/target/site/doxygen/xml --src-dir ./ --format lcov --output ./calculator-app/target/site/coverxygen/lcov.info --prefix %currentDir%\calculator-app\
-
-echo Run lcov genhtml
-call perl C:\ProgramData\chocolatey\lib\lcov\tools\bin\genhtml ./calculator-app\target\site\coverxygen\lcov.info -o calculator-app/target/site/coverxygen
+echo Package Output Jar Files
+tar -czvf release/application-binary.tar.gz -C calculator-app/target '*.jar'
 
 echo Package Jacoco Test Coverage Report (Optional)
-call tar -czvf test-jacoco-report.tar.gz -C calculator-app/target/site/jacoco .
+call tar -czvf release/test-jacoco-report.tar.gz -C calculator-app/target/site/jacoco .
 
 echo Package ReportGenerator Test Coverage Report
-call tar -czvf test-coverage-report.tar.gz -C calculator-app/target/site/coveragereport .
+call tar -czvf release/test-coverage-report.tar.gz -C calculator-app/target/site/coveragereport .
 
 echo Package Code Documentation
-call tar -czvf application-documentation.tar.gz -C calculator-app/target/site/doxygen .
+call tar -czvf release/application-documentation.tar.gz -C calculator-app/target/site/doxygen .
 
 echo Package Documentation Coverage
-call tar -czvf doc-coverage-report.tar.gz -C calculator-app/target/site/coverxygen .
+call tar -czvf release/doc-coverage-report.tar.gz -C calculator-app/target/site/coverxygen .
 
 echo Package Product Site
-call tar -czvf application-site.tar.gz -C calculator-app/target/site .
-
-echo Copy badge files to the "assets" directory
-
-copy calculator-app\target\site\coveragereport\badge_combined.svg assets
-copy calculator-app\target\site\coveragereport\badge_combined.svg assets
-copy calculator-app\target\site\coveragereport\badge_branchcoverage.svg assets
-copy calculator-app\target\site\coveragereport\badge_linecoverage.svg assets
-copy calculator-app\target\site\coveragereport\badge_methodcoverage.svg assets
+call tar -czvf release/application-site.tar.gz -C calculator-app/target/site .
 
+echo ....................
 echo Operation Completed!
+echo ....................
 pause

Doxyfile

@@ -61,7 +61,7 @@ PROJECT_BRIEF          = "A simple library for performing basic arithmetic opera
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = assets/favicon.png
+PROJECT_LOGO           = C:/Users/ugur.coruh/Desktop/eclipse-java-maven-template/assets/rteu_logo.jpg
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -917,7 +917,8 @@ WARN_LOGFILE           = doxygen.log
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = calculator-app/src/main/java
+INPUT                  = calculator-app/src/main/java \
+                         README.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1070,7 +1071,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = assets
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1131,7 +1132,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = README.md
 
 # The Fortran standard specifies that for fixed formatted Fortran code all
 # characters from position 72 are to be considered as comment. A common
@@ -1933,7 +1934,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
 # The default value is: YES.
 
-GENERATE_LATEX         = NO
+GENERATE_LATEX         = YES
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

assets/rteu_logo.jpg

@@ -25,7 +25,7 @@
 	</bannerLeft>
 
 	<bannerRight>
-		<src>images/banner.png</src>
+		<src>images/rteu_logo.jpg</src>
 	</bannerRight>
 
 	<poweredBy>
@@ -39,10 +39,11 @@
 
 		<menu name="Overview">
 				<item name="Introduction" href="index.html" />
+				<item name="README.md" href="readme.html" />
+				<item name="Overiew Markdown" href="overview.html" />
 				<item name="Project Info" href="project-info.html" />
 				<item name="Project Summary" href="summary.html" />
 				<item name="Project Team" href="team.html" />
-				<item name="Markdown Sample" href="overview.html" />
 				<item name="GitHub Repository" href="https://github.com/ucoruh/eclipse-java-maven-template" />
 		</menu>