[0.5.0] - 2023-09-21

Author: fugerit79

.github/workflows/build_maven_package.yml

@@ -0,0 +1,39 @@
+# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: CI build maven package 
+
+on:
+  push:
+    branches:
+    - main
+    - develop
+    - branch-sonarcloud    
+  pull_request:
+    branches:
+    - main
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up JDK 11
+      uses: actions/setup-java@v3
+      with:
+        java-version: '11'
+        distribution: 'corretto'
+        cache: maven
+    - name: Build with Maven
+      run: mvn -P full,coverage,metadata -B package --file pom.xml
+
+    # Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive
+    - name: Update dependency graph
+      uses: advanced-security/[email protected]

.github/workflows/deploy_maven_package.yml

@@ -0,0 +1,36 @@
+# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: CI deploy maven package 
+
+on:
+  push:
+    branches:
+    - deploy
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up JDK 11
+      uses: actions/setup-java@v3
+      with:
+        java-version: '11'
+        distribution: 'corretto'
+        cache: maven
+    - name: Release Maven package
+      uses: samuelmeuli/action-maven-publish@v1
+      with:
+        gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+        gpg_passphrase: ${{ secrets.PASSPHRASE }}
+        nexus_username: ${{ secrets.OSS_USERNAME }}
+        nexus_password: ${{ secrets.OSS_PASSWORD }}
+        maven_args: -P doRelease

.github/workflows/sonarcloud-maven.yml

@@ -47,7 +47,7 @@ jobs:
           # SonarCloud access token should be generated from https://sonarcloud.io/account/security/
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
       - name: Build and analyze
-        run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Pcoverage
+        run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Pcoverage -Pcoverage,sonarfugerit -Dsonar.projectKey=fugerit-org_${{github.event.repository.name}}
         env:
           # Needed to get some information about the pull request, if any
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -1,3 +1,27 @@
+# Changelog
+
+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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.5.0] - 2023-09-21
+
+### Added
+
+- [workflow deploy on branch deploy](.github/workflows/deploy_maven_package.yml)
+- [workflow maven build](.github/workflows/build_maven_package.yml)
+- keep a changelog and coverage badge
+
+### Changed
+
+- [workflow sonar cloud](.github/workflows/sonarcloud-maven.yml)
+- fj-bom version set to 1.4.0
+- fj-core version set to 8.3.7
+- fj-doc version set to 8.3.7
+
 0.4.2 (2023-08-29)
 ------------------
 * removed unused class org.fugerit.java.yaml.doc/FjDocFacade

README.md

@@ -2,9 +2,11 @@
 
 Tool for auto documentation of yaml / openapi
 
+[![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](CHANGELOG.md) 
 [![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/yaml-doc-tool.svg)](https://mvnrepository.com/artifact/org.fugerit.java/yaml-doc-tool)
 [![license](https://img.shields.io/badge/License-Apache%20License%202.0-teal.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_yaml-doc-tool&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_yaml-doc-tool)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_yaml-doc-tool&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fugerit-org_yaml-doc-tool)
 
 **Usage:**  
 

pom.xml

@@ -7,11 +7,11 @@
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-bom</artifactId>
-		<version>1.2.5</version>
+		<version>1.4.0</version>
 		<relativePath></relativePath>
 	</parent>
 
-	<version>0.4.2</version>
+	<version>0.5.0</version>
 	<packaging>jar</packaging>
 
 	<name>yaml-doc-tool</name>
@@ -30,10 +30,9 @@
 	    <maven.compiler.source>${java-version-compliance}</maven.compiler.source>
 	    <maven.compiler.target>${java-version-compliance}</maven.compiler.target>
 		<!-- libraries versions -->
-		<fj-version>8.2.0</fj-version>
-		<fj-doc-version>1.5.3</fj-doc-version>
-		<snake-yaml-version>2.2</snake-yaml-version>
-		 <fj-test-helper-version>0.3.1</fj-test-helper-version>   
+		<fj-version>8.3.7</fj-version>
+		<fj-doc-version>3.0.7</fj-doc-version>
+		<snake-yaml-version>2.2</snake-yaml-version>   
 	    <!-- sonar cloud configuration -->
 		<sonar.host.url>https://sonarcloud.io</sonar.host.url>
 		<sonar.organization>fugerit-org</sonar.organization>
@@ -141,7 +140,6 @@
 		<dependency>
 			<groupId>org.fugerit.java</groupId>
 			<artifactId>fj-test-helper8</artifactId>
-			<version>${fj-test-helper-version}</version>
 			<scope>test</scope>
 			<exclusions>
 				<exclusion>