Merge pull request #544 from fugerit-org/543-enhancement-fj-doc-maven-plugin-init-goal-add-ci-support-for-github

fugerit79 · web-flow · commit c8b83130789c · 2025-10-14T22:17:30.000+02:00
543 enhancement fj doc maven plugin init goal add ci support for GitHub
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- fj-doc-maven-plugin, init goal, add CI support for GitHub <https://github.com/fugerit-org/fj-doc/issues/543>
 - fj-doc-maven-plugin, init goal, 'addFormatting' <https://github.com/fugerit-org/fj-doc/issues/541>
 
 ### Changed
diff --git a/README.md b/README.md
@@ -56,7 +56,9 @@ mvn org.fugerit.java:fj-doc-maven-plugin:init \
 -DgroupId=org.example.doc \
 -DartifactId=fugerit-demo-quarkus-3 \
 -Dflavour=quarkus-3 \
--DaddJacoco=true
+-DaddJacoco=true \
+-DaddFormatting=true \
+-DwithCI=GitHub
 ```
 It will create a new folder as for the {artifactId} parameter 
 (in our example : *fugerit-demo-quarkus-3*)
diff --git a/fj-doc-guide/src/main/docs/asciidoc/chapters/00_2_release_notes.adoc b/fj-doc-guide/src/main/docs/asciidoc/chapters/00_2_release_notes.adoc
@@ -6,6 +6,7 @@ Whereas the link:https://github.com/fugerit-org/fj-doc/blob/main/CHANGELOG.md[CH
 [#doc-release-notes-unreleased]
 ==== Unreleased
 
+- fj-doc-maven-plugin, init goal, add CI support for GitHub link:https://github.com/fugerit-org/fj-doc/issues/543[#543]
 - fj-doc-maven-plugin, init goal, 'addFormatting' parameter link:https://github.com/fugerit-org/fj-doc/issues/541[#541]
 
 [#doc-release-notes-8-16-9]
diff --git a/fj-doc-guide/src/main/docs/asciidoc/chapters/02_2_maven_plugin_init.adoc b/fj-doc-guide/src/main/docs/asciidoc/chapters/02_2_maven_plugin_init.adoc
@@ -27,6 +27,7 @@ Project folder will be `./${artifactId}/`.
 | flavourVersion | false    | see below      | override default framework version if supported (recommended : leave default or blank)
 | addJacoco (*)     | false     | false          | add jacoco coverage support
 | addFormatting (*)     | false     | false          | add maven plugin formatter with rules from link:https://github.com/fugerit-org/fugerit-code-rules[fugerit-code-rules]
+| withCI (*)     | false     |           | It will generate a basic CI workflow for give platform. Supported values : 'github'
 |====================================================================================================================================
 
 (*) Currently not working on gradle flavours
diff --git a/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/maven/MojoInit.java b/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/maven/MojoInit.java
@@ -42,6 +42,9 @@ public class MojoInit extends MojoAdd {
     @Parameter(property = "addFormatting", defaultValue = "false", required = false)
     protected boolean addFormatting;
 
+    @Parameter(property = "withCI", required = false)
+    protected String withCI;
+
     public MojoInit() {
         this.baseInitFolder = ".";
     }
@@ -72,6 +75,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                 context.setBasePackage( this.basePackage );
                 context.setAddJacoco( this.addJacoco );
                 context.setAddFormatting( this.addFormatting );
+                context.setWithCI( this.withCI );
                 this.getLog().info( String.format( "flavour context : %s", context ) );
                 String actualVersion = FlavourFacade.initProject( context );
                 if ( FlavourFacade.FLAVOUR_DIRECT.equals( actualVersion ) ) {
diff --git a/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FeatureFacade.java b/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FeatureFacade.java
@@ -40,7 +40,7 @@ private static void copyResourcesList( File baseFolder, String mode, String id )
     protected static void insureParent( File file ) throws IOException {
         File parentFile = file.getParentFile();
         if ( !parentFile.exists() ) {
-            log.info( "creates parent directory {}, mkdirs:?", parentFile.getCanonicalPath(), parentFile.mkdirs() );
+            log.info( "creates parent directory {}, mkdirs:? {}", parentFile.getCanonicalPath(), parentFile.mkdirs() );
         }
     }
 
diff --git a/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FlavourContext.java b/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FlavourContext.java
@@ -55,6 +55,9 @@ public class FlavourContext {
     @Getter @Setter
     private boolean addFormatting;
 
+    @Getter @Setter
+    private String withCI;
+
     public String getDefaultJacocoVersion() {
         return FlavourFacade.getFlavourDefaultVersion().getProperty( "jacoco-plugin-version" );
     }
@@ -71,6 +74,10 @@ public String getDefaultFormatSkip() {
         return FlavourFacade.getFlavourDefaultVersion().getProperty( "format.skip" );
     }
 
+    public String getWithCIPath() {
+        return FlavourFacade.getFlavourDefaultVersion().getProperty( "withCI.path."+this.withCI.toLowerCase() );
+    }
+
     private String toClassName( String base, String splitString ) {
         StringBuilder buf = new StringBuilder();
         String[] split = base.split( splitString );
diff --git a/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FlavourFacade.java b/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FlavourFacade.java
@@ -49,6 +49,8 @@ private FlavourFacade() {}
 
     private static final Properties FLAVOURS_DEFAULT_VERSION = PropsIO.loadFromClassLoaderSafe( "config/flavour/flavour_versions_default.properties" );
 
+    public static final String WITH_CI_GITHUB = "github";
+
     public static Properties getFlavourDefaultVersion() {
         return new Properties( FLAVOURS_DEFAULT_VERSION );
     }
@@ -67,12 +69,22 @@ public static boolean isGradleKtsFlavour(String flavour ) {
         return prop;
     });
 
+    public static final Set<String> SUPPORTED_CI =  Collections.unmodifiableSet( new HashSet<>( Arrays.asList( WITH_CI_GITHUB ) ) );
+
+    private static void checkCI( FlavourContext context ) {
+        if ( StringUtils.isNotEmpty( context.getWithCI() ) && !SUPPORTED_CI.contains( context.getWithCI().toLowerCase() ) ) {
+            throw new ConfigRuntimeException( String.format( "withCI not supported : %s (allowed values are %s)", context.getWithCI(), SUPPORTED_CI ) );
+        }
+    }
+
     public static String initProject( FlavourContext context ) throws IOException, TemplateException {
         log.info( "generate flavour : {}", context.getFlavour() );
         String actualFlavour = MAP_FLAVOURS.getProperty( context.getFlavour(), context.getFlavour() );
         if ( SUPPORTED_FLAVOURS.contains( actualFlavour ) ) {
+            checkCI( context );
             checkFlavour( context, actualFlavour );
             initFlavour( context, actualFlavour );
+            initCI( context, actualFlavour );
         } else {
             throw new ConfigRuntimeException( String.format( "flavour not supported : %s", context.getFlavour() ) );
         }
@@ -85,7 +97,7 @@ public static void checkFlavour( FlavourContext context, String actualFlavour )
                 || FLAVOUR_SPRINGBOOT_3.equals( actualFlavour ) || FLAVOUR_OPENLIBERTY.equals( actualFlavour ) ) && javaVersion < 17 ) {
             throw new ConfigRuntimeException( String.format( "Minimum java version for %s is 17", actualFlavour ) );
         } else if ( FLAVOUR_QUARKUS_2.equals( actualFlavour ) && javaVersion != 11 ) {
-            log.info( "quarkus 2 is a legacy flavour, javaRelease %s will default to '11'", javaVersion );
+            log.info( "quarkus 2 is a legacy flavour, javaRelease {} will default to '11'", javaVersion );
         }
         log.info( "checkFlavour {} done", actualFlavour );
         checkFlavourVersion( context, actualFlavour );
@@ -162,11 +174,26 @@ private static void initFlavour( FlavourContext context, String actualFlavour )
         try ( StringWriter writer = new StringWriter() ) {
             FreemarkerTemplateFacade.processFile( freemarkerProcessYamlPath, writer, data );
             FlavourConfig flavourConfig = mapper.readValue( writer.toString(), FlavourConfig.class );
-            log.info( "floavourConfig {}", flavourConfig.getFlavour() );
+            log.info( "flavourConfig {}", flavourConfig.getFlavour() );
             flavourConfig.getProcess().forEach( entry -> FeatureFacade.processEntry( entry, data ) );
         }
     }
 
+    private static void initCI( FlavourContext context, String actualFlavour ) throws IOException, TemplateException {
+        if ( StringUtils.isNotEmpty( context.getWithCI() ) && !FlavourFacade.isGradleKtsFlavour( actualFlavour ) ) {
+            String withCI = context.getWithCI().toLowerCase();
+            String relativeDestinationPath = context.getWithCIPath();
+            String ciTemplatePath = String.format( "ci/%s-ci.ftl", withCI );
+            File outputCIFile = new File( context.getProjectFolder(), relativeDestinationPath );
+            log.info( "generating CI : mkdir? {} -> {}", outputCIFile.getParentFile().mkdirs(), outputCIFile.getCanonicalPath() );
+            try ( FileWriter writer = new FileWriter( outputCIFile ) ) {
+                Map<String, Object> data = new HashMap<>();
+                data.put( "context", context );
+                FreemarkerTemplateFacade.processFile( ciTemplatePath, writer, data );
+            }
+        }
+    }
+
 
 
 }
diff --git a/fj-doc-maven-plugin/src/main/resources/config/flavour/flavour_versions_default.properties b/fj-doc-maven-plugin/src/main/resources/config/flavour/flavour_versions_default.properties
@@ -16,4 +16,7 @@ jacoco-plugin-version=0.8.13
 # formatting
 mvn-formatter-plugin-version=2.29.0
 fugerit-code-rules-version=0.1.1
-format.skip=false
+format.skip=false
+
+# ci
+withCI.path.github=.github/workflows/ci.yml
diff --git a/fj-doc-maven-plugin/src/main/resources/config/template/ci/github-ci.ftl b/fj-doc-maven-plugin/src/main/resources/config/template/ci/github-ci.ftl
@@ -0,0 +1,28 @@
+name: CI workflow
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up JDK ${context.javaRelease}
+        uses: actions/setup-java@v4
+        with:
+          java-version: ${context.javaRelease}
+          distribution: 'zulu'
+      - name: Cache Maven packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2
+          key: ${r"${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}"}
+          restore-keys: ${r"${{ runner.os }}"}-m2
+      - name: Build
+        run: mvn clean install
diff --git a/fj-doc-maven-plugin/src/test/java/test/org/fugerit/java/doc/project/facade/TestInit.java b/fj-doc-maven-plugin/src/test/java/test/org/fugerit/java/doc/project/facade/TestInit.java
@@ -57,6 +57,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                 this.addLombok = true;
                 this.addJacoco = true;
                 this.addFormatting = true;
+                this.withCI = FlavourFacade.WITH_CI_GITHUB;
                 this.flavour = currentFlavour;
                 if ( FlavourFacade.FLAVOUR_QUARKUS_3.equals( currentFlavour ) ) {
                     this.basePackage = "org.fugerit.java.basepack";
@@ -94,6 +95,29 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         Assertions.assertTrue( projectDir.exists() );
     }
 
+    @Test
+    void createFailCI() {
+        String currentFlavour = FlavourFacade.FLAVOUR_DIRECT;
+        File projectDir = initConfigWorker( currentFlavour+"-fail-ci" );
+        MojoInit mojoInit = new MojoInit() {
+            @Override
+            public void execute() throws MojoExecutionException, MojoFailureException {
+                this.baseInitFolder = projectDir.getAbsolutePath();
+                this.projectVersion = "1.0.0-SNAPSHOT";
+                this.groupId = "org.fugerit.java.test";
+                this.artifactId = "fugerit-test-"+currentFlavour+"-fail-ci";
+                this.javaRelease = "21";
+                this.version = "8.16.9";
+                this.extensions = "fj-doc-base,fj-doc-base-json,fj-doc-base-yaml,fj-doc-base-kotlin,fj-doc-freemarker,fj-doc-mod-fop,fj-doc-mod-poi,fj-doc-mod-opencsv";
+                this.addLombok = true;
+                this.withCI = "NA";
+                this.flavour = currentFlavour;
+                super.execute();
+            }
+        };
+        Assertions.assertThrows(MojoFailureException.class, mojoInit::execute);
+    }
+
     @Test
     void testMojoQuarkus3GradleGroovyAndKts() throws MojoExecutionException, MojoFailureException {
         for ( String currentFlavour : Arrays.asList( FlavourFacade.FLAVOUR_QUARKUS_3_GRADLE, FlavourFacade.FLAVOUR_QUARKUS_3_GRADLE_KTS ) ) {
diff --git a/fj-doc-playground-quarkus/src/main/java/org/fugerit/java/doc/playground/init/ProjectInitInput.java b/fj-doc-playground-quarkus/src/main/java/org/fugerit/java/doc/playground/init/ProjectInitInput.java
@@ -66,4 +66,8 @@ public class ProjectInitInput {
     @Setter
     private boolean addFormatting;
 
+    @Getter
+    @Setter
+    private String withCI;
+
 }
diff --git a/fj-doc-playground-quarkus/src/main/java/org/fugerit/java/doc/playground/init/ProjectRest.java b/fj-doc-playground-quarkus/src/main/java/org/fugerit/java/doc/playground/init/ProjectRest.java
@@ -81,6 +81,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                         this.addDirectPlugin = data.isAddDirectPlugin();
                         this.addJacoco = data.isAddJacoco();
                         this.addFormatting = data.isAddFormatting();
+                        this.withCI = data.getWithCI();
                         super.execute();
                     }
                 };
diff --git a/fj-doc-playground-quarkus/src/main/react/src/playground/DocProjectInit.jsx b/fj-doc-playground-quarkus/src/main/react/src/playground/DocProjectInit.jsx
@@ -39,7 +39,8 @@ const DocProjectInit = ({setHelpContent}) => {
 	const [addVerifyPlugin, setAddVerifyPlugin] = useState(true); // State to handle addVerifyPlugin selection
 	const [addDirectPlugin, setAddDirectPlugin] = useState(false); // State to handle addDirectPlugin selection
     const [addJacoco, setAddJacoco] = useState(false); // State to handle addJacoco selection
-    const [addFormatting, setAddFormatting] = useState(false); // State to handle addJacoco selection
+    const [addFormatting, setAddFormatting] = useState(false); // State to handle addFormatting selection
+    const [withCI, setWithCI] = useState(''); // State to handle withCI selection
 
 	// useEffect to fetch data from the API when the component mounts
 	useEffect(() => {
@@ -103,6 +104,11 @@ const DocProjectInit = ({setHelpContent}) => {
 		setFlavourVersion(event.target.value);
 	};
 
+    // Handle change event for CI select
+    const handleCIChange = (event) => {
+        setWithCI(event.target.value);
+    };
+
 	// Handle the submit button click
 	const handleSubmit = async () => {
 		setIsSubmitting(true); // Set loading state to true when submission starts
@@ -117,6 +123,7 @@ const DocProjectInit = ({setHelpContent}) => {
 			addDirectPlugin,
             addJacoco,
             addFormatting,
+            withCI,
 			extensionList: selectedExtensions,
 		};
 		try {
@@ -300,7 +307,23 @@ const DocProjectInit = ({setHelpContent}) => {
                         </RadioGroup>
                     </FormControl>
                 </Grid>
-				<Grid item xs={12} sm={12}>
+                <Grid item xs={12} sm={6}>
+                    {/* Text field for withCI */}
+                    <FormControl fullWidth margin="normal">
+                        <InputLabel id="venus-ci-select-label">CI</InputLabel>
+                        <Select
+                            labelId="venus-ci-select-label"
+                            id="venus-ci-select"
+                            value={withCI}
+                            onChange={handleCIChange}
+                        >
+                            {/* Allowed values for CI */}
+                            <MenuItem value={''}>None</MenuItem>
+                            <MenuItem value={'github'}>GitHub</MenuItem>
+                        </Select>
+                    </FormControl>
+                </Grid>
+				<Grid item xs={12} sm={6}>
 					{/* Text field for flavourVersion */}
 					<TextField
 						label="Flavour version, recommended : leave default (blank)"

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ private static void copyResourcesList( File baseFolder, String mode, String id )`
`40`	`40`	`protected static void insureParent( File file ) throws IOException {`
`41`	`41`	`File parentFile = file.getParentFile();`
`42`	`42`	`if ( !parentFile.exists() ) {`
`43`		`- log.info( "creates parent directory {}, mkdirs:?", parentFile.getCanonicalPath(), parentFile.mkdirs() );`
	`43`	`+ log.info( "creates parent directory {}, mkdirs:? {}", parentFile.getCanonicalPath(), parentFile.mkdirs() );`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`