Documentation on Github Pages (#4)

OlegCIB · web-flow · commit 4d2a036d2385 · 2025-02-28T19:52:19.000+01:00
* preparing for compatibility check

* using corrent parent version

* using correct parent versions

* using cibseven-engine-spring dependency

* switched from javax to jakarta

* run docs action on main and documentation branches

* Deploy latest develop snapshot docs to GH pages for main and documentation branches

* preparing documentation

* css and text changes

* back to monochrome, logo als svg

* no monochrome header in dark mode, back to png logo

* renamed to cibseven-tests

* report directory removed to cibseven-tests

* Update README.md
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -3,7 +3,8 @@ name: Build the docs
 on:
   push:
     branches:
-      - master
+      - main
+      - documentation
     tags:
       - '*'
   release:
@@ -69,9 +70,14 @@ jobs:
         if: startsWith(github.ref, 'refs/tags/')
         run: mike set-default stable --push
 
-      # This is for master branch
+      # This is for main branch
       - name: Deploy latest develop snapshot docs to GH pages.
-        if: github.ref == 'refs/heads/master'
+        if: github.ref == 'refs/heads/main'
+        run: mike deploy snapshot -u --push
+      
+      # This is for documentation branch
+      - name: Deploy latest develop snapshot docs to GH pages.
+        if: github.ref == 'refs/heads/documentation'
         run: mike deploy snapshot -u --push
 
       # This is for release close
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
-[![](https://img.shields.io/badge/Community%20Extension-An%20open%20source%20community%20maintained%20project-FF4700)](https://github.com/cibseven-community-hub/community)
-![Compatible with: Camunda Platform 7](https://img.shields.io/badge/Compatible%20with-Camunda%20Platform%207-26d07c)
+[![](https://img.shields.io/badge/Community%20Extension-An%20open%20source%20community%20maintained%20project-E11E19)](https://github.com/cibseven-community-hub)
+[![Compatible with: CIB seven](https://img.shields.io/badge/Compatible%20with-CIB%20seven-26d07c)](https://github.com/cibseven/cibseven)
 
 
 # CIB seven Process Test Coverage
@@ -24,7 +24,7 @@ This CIB seven community extension **visualises** test process **paths** and **c
 
 ## Installation
 
- Add a **Maven test dependency** to your project <a href="https://maven-badges.herokuapp.com/maven-central/org.cibseven.community.process_test_coverage/process-test-coverage-bom"><img src="https://maven-badges.herokuapp.com/maven-central/org.cibseven.community.process_test_coverage/process-test-coverage-bom/badge.svg" align="right" /></a>
+ Add a **Maven test dependency** to your project <a href="https://maven-badges.herokuapp.com/maven-central/org.cibseven.community.process_test_coverage/process-test-coverage-bom"><img src="https://maven-badges.herokuapp.com/maven-central/org.cibseven.community.process_test_coverage/cibseven-process-test-coverage-bom/badge.svg" align="right" /></a>
 0
 ### JUnit5
 
diff --git a/docs/assets/css/extra.css b/docs/assets/css/extra.css
@@ -9,35 +9,33 @@
 
 [data-md-color-scheme="default"] {
   /*
-   Camunda colors
+   CIB colors
    */
-   --camunda-orange-1: #f38a07;
-   --camunda-orange-2: #f27d06;
-   --camunda-orange-3: #f04609;
+   --primary: #E11E19;
+   --secondary: #4D6278;
    --monochrome-50: #7f7f7f;
 
 
   /*
    Default colors adjustments
    */
    --md-primary-fg-color: var(--monochrome-50);
-   --md-accent-fg-color: var(--camunda-orange-3);
-   --md-footer-bg-color: var(--camunda-orange-1);
+   --md-accent-fg-color: var(--primary);
+   --md-footer-bg-color: var(--secondary);
 }
 
 [data-md-color-scheme="slate"] {
   /*
-   Camunda colors
+   CIB colors
    */
-  --camunda-orange-1: #f38a07;
-  --camunda-orange-2: #f27d06;
-  --camunda-orange-3: #f04609;
+   --primary: #E11E19;
+   --secondary: #4D6278;
 
 
   /*
    Default colors adjustments
    */
   --md-primary-fg-color: var(--monochrome-50);
-  --md-accent-fg-color: var(--camunda-orange-3);
-  --md-footer-bg-color: var(--camunda-orange-1);
+  --md-accent-fg-color: var(--primary);
+  --md-footer-bg-color: var(--secondary);
 }
diff --git a/docs/assets/img/camunda-logo.png b/docs/assets/img/camunda-logo.png
diff --git a/docs/assets/img/cibseven-logo.png b/docs/assets/img/cibseven-logo.png
diff --git a/docs/developer-guide/contribution.md b/docs/developer-guide/contribution.md
@@ -1,13 +1,13 @@
 # How to Contribute
 
-We'd love you to contribute to this project by filing bugs, helping others on the [issue tracker](https://github.com/cibseven/process-test-coverage/issues), and by contributing features/bug fixes through pull requests.
+We'd love you to contribute to this project by filing bugs, helping others on the [issue tracker](https://github.com/cibseven-community-hub/process-test-coverage/issues), and by contributing features/bug fixes through pull requests.
 
 Read more on [how to get the project up and running](#setting-up-the-project-locally).
 
 
 ## Creating Issues
 
-Please use our [issue tracker](https://github.com/cibseven/cibseven-process-test-coverage/issues) for project communication.
+Please use our [issue tracker](https://github.com/cibseven-community-hub/cibseven-process-test-coverage/issues) for project communication.
 When using the issue tracker:
 
 * Be descriptive when creating an issue (what, where, when and how does a problem pop up)?
@@ -22,7 +22,7 @@ Create a pull request if you would like to have an in-depth discussion about som
 The project is build using [Maven 3](https://maven.apache.org/) as build tool.
 To build the project by yourself, go to your cmd line and enter ```mvn clean install``` on the root of the checked out project.
 
-1. git clone https://github.com/cibseven/cibseven-process-test-coverage.git
+1. git clone https://github.com/cibseven-community-hub/cibseven-process-test-coverage.git
 2. cd cibseven-process-test-coverage/
 3. mvn clean install
 
diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md
@@ -49,7 +49,7 @@ possible to configure the output directory for the aggregation report inside the
                 <goal>aggregate</goal>
             </goals>
             <configuration>
-                <reportDirectory>build/camunda-tests</reportDirectory>
+                <reportDirectory>build/cibseven-tests</reportDirectory>
                 <outputDirectory>aggregation</outputDirectory>
             </configuration>
         </execution>
@@ -69,14 +69,14 @@ plugins {
 }
 
 aggregateProcessTestCoverage {
-    reportDirectory = 'build/camunda-tests'
+    reportDirectory = 'build/cibseven-tests'
     outputDirectory = 'aggregation'
 }
 ```
 
 ### Legacy way via system property
 
-We still support the old way to configure the reporting directory via system property `camunda-process-test-coverage.target-dir-root`.
+We still support the old way to configure the reporting directory via system property `cibseven-process-test-coverage.target-dir-root`.
 
 #### Maven
 ```xml
@@ -85,7 +85,7 @@ We still support the old way to configure the reporting directory via system pro
 <artifactId>maven-surefire-plugin</artifactId>
 <configuration>
   <systemPropertyVariables>
-    <camunda-process-test-coverage.target-dir-root>${project.build.directory}/my-coverage-reports/</camunda-process-test-coverage.target-dir-root>
+    <cibseven-process-test-coverage.target-dir-root>${project.build.directory}/my-coverage-reports/</cibseven-process-test-coverage.target-dir-root>
   </systemPropertyVariables>
 </configuration>
 </plugin>
@@ -96,7 +96,7 @@ We still support the old way to configure the reporting directory via system pro
 tasks {
     withType<Test> {
         systemProperties = mapOf(
-            "camunda-process-test-coverage.target-dir-root" to "$buildDir/my-coverage-reports/"
+            "cibseven-process-test-coverage.target-dir-root" to "$buildDir/my-coverage-reports/"
         )
     }
 }
diff --git a/examples/jgiven-platform-7/src/test/resources/application.yaml b/examples/jgiven-platform-7/src/test/resources/application.yaml
@@ -1,5 +1,5 @@
 spring:
-  # spring.datasource.url: jdbc:h2:file:./camunda-h2-database
+  # spring.datasource.url: jdbc:h2:file:./cibseven-h2-database
   datasource:
     url: jdbc:h2:mem:camunda;DB_CLOSE_ON_EXIT=FALSE
 
diff --git a/examples/spring-starter-platform-7/src/test/resources/application.yaml b/examples/spring-starter-platform-7/src/test/resources/application.yaml
@@ -1,5 +1,5 @@
 spring:
-  # spring.datasource.url: jdbc:h2:file:./camunda-h2-database
+  # spring.datasource.url: jdbc:h2:file:./cibseven-h2-database
   datasource:
     url: jdbc:h2:mem:camunda;DB_CLOSE_ON_EXIT=FALSE
 
diff --git a/examples/spring-test-platform-7/src/test/resources/application.yaml b/examples/spring-test-platform-7/src/test/resources/application.yaml
@@ -1,5 +1,5 @@
 spring:
-  # spring.datasource.url: jdbc:h2:file:./camunda-h2-database
+  # spring.datasource.url: jdbc:h2:file:./cibseven-h2-database
   datasource:
     url: jdbc:h2:mem:camunda;DB_CLOSE_ON_EXIT=FALSE
 
diff --git a/extension/report-aggregator-gradle-plugin/src/test/kotlin/org/cibseven/community/process_test_coverage/report/aggregator/ReportAggregatorPluginTest.kt b/extension/report-aggregator-gradle-plugin/src/test/kotlin/org/cibseven/community/process_test_coverage/report/aggregator/ReportAggregatorPluginTest.kt
@@ -124,15 +124,15 @@ class ReportAggregatorPluginTest {
             }
             
             aggregateProcessTestCoverage {
-                reportDirectory = 'build/camunda-tests'
+                reportDirectory = 'build/cibseven-tests'
                 outputDirectory = 'aggregation'
             }
             
         """
         Files.write(buildFile.toPath(), buildFileContent.toByteArray())
         val result = gradleRunner.build()
         assertEquals(TaskOutcome.SUCCESS, result.task(":aggregateProcessTestCoverage")?.outcome)
-        assertResult("build/camunda-tests/aggregation/report.json")
+        assertResult("build/cibseven-tests/aggregation/report.json")
     }
 
     private fun assertResult(expectedFile: String = "build/process-test-coverage/all/report.json") {
diff --git a/extension/report-aggregator-gradle-plugin/src/test/resources/different_report_directory/build/cibseven-tests/test.FirstTest/report.json b/extension/report-aggregator-gradle-plugin/src/test/resources/different_report_directory/build/cibseven-tests/test.FirstTest/report.json
diff --git a/extension/report-aggregator-maven-plugin/src/main/kotlin/org/cibseven/community/process_test_coverage/report/aggregator/ReportAggregatorMojo.kt b/extension/report-aggregator-maven-plugin/src/main/kotlin/org/cibseven/community/process_test_coverage/report/aggregator/ReportAggregatorMojo.kt
@@ -36,7 +36,7 @@ import java.util.*
 class ReportAggregatorMojo : AbstractMojo(), MavenReport {
 
     companion object {
-        var TARGET_DIR_ROOT: String? = System.getProperty("camunda-process-test-coverage.target-dir-root")
+        var TARGET_DIR_ROOT: String? = System.getProperty("cibseven-process-test-coverage.target-dir-root")
     }
 
     @Parameter(defaultValue = "target/process-test-coverage")
diff --git a/extension/report-aggregator-maven-plugin/src/test/kotlin/org/cibseven/community/process_test_coverage/report/aggregator/ReportAggregatorMojoIT.kt b/extension/report-aggregator-maven-plugin/src/test/kotlin/org/cibseven/community/process_test_coverage/report/aggregator/ReportAggregatorMojoIT.kt
@@ -95,7 +95,7 @@
 //
 //        assertThat(result.mavenProjectResult.targetProjectDirectory
 //            .resolve("build")
-//            .resolve("camunda-tests/aggregation/report.json"))
+//            .resolve("cibseven-tests/aggregation/report.json"))
 //            .exists()
 //            .isRegularFile()
 //            .content()
diff --git a/extension/report-aggregator-maven-plugin/src/test/resources/org/cibseven/community/process_test_coverage/report/aggregator/ReportAggregatorMojoIT/different_report_directory/build/cibseven-tests/test.FirstTest/report.json b/extension/report-aggregator-maven-plugin/src/test/resources/org/cibseven/community/process_test_coverage/report/aggregator/ReportAggregatorMojoIT/different_report_directory/build/cibseven-tests/test.FirstTest/report.json
diff --git a/extension/report-aggregator-maven-plugin/src/test/resources/org/cibseven/community/process_test_coverage/report/aggregator/ReportAggregatorMojoIT/different_report_directory/pom.xml b/extension/report-aggregator-maven-plugin/src/test/resources/org/cibseven/community/process_test_coverage/report/aggregator/ReportAggregatorMojoIT/different_report_directory/pom.xml
@@ -41,7 +41,7 @@
                             <goal>aggregate</goal>
                         </goals>
                         <configuration>
-                            <reportDirectory>build/camunda-tests</reportDirectory>
+                            <reportDirectory>build/cibseven-tests</reportDirectory>
                             <outputDirectory>aggregation</outputDirectory>
                         </configuration>
                     </execution>
diff --git a/extension/report-generator/src/main/java/org/cibseven/community/process_test_coverage/report/CoverageReportUtil.java b/extension/report-generator/src/main/java/org/cibseven/community/process_test_coverage/report/CoverageReportUtil.java
@@ -52,7 +52,7 @@ public class CoverageReportUtil {
     /**
      * Root directory for all coverage reports.
      */
-    public static String TARGET_DIR_ROOT = System.getProperty("camunda-process-test-coverage.target-dir-root", "target/process-test-coverage/");
+    public static String TARGET_DIR_ROOT = System.getProperty("cibseven-process-test-coverage.target-dir-root", "target/process-test-coverage/");
     public static final String REPORT_RESOURCES = "static";
     private static final String REPORT_TEMPLATE = "html/bpmn.report-template.html";
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,22 +5,22 @@
 # To run: mkdocs serve
 # ###############################
 
-site_name: Camunda Process Test Coverage
-site_url: https://camunda-community-hub.github.io/camunda-process-test-coverage/
-site_author: Camunda OSS Developers
+site_name: CIB seven Process Test Coverage
+site_url: https://cibseven-community-hub.github.io/cibseven-process-test-coverage/
+site_author: CIB Seven OSS Developers
 site_description: >-
-  This Camunda Platform 7 and Platform 8 ommunity extension visualises test process
+  This CIB seven Community extension visualises test process
   paths and checks your process model coverage ratio. Running  typical
   tests now leaves html files in your build output.
 
-copyright: Copyright &copy; 2022
+copyright: Copyright &copy; 2025
 
 use_directory_urls: false
 
 # Repository
-repo_name: camunda-community-hub/camunda-process-test-coverage
-repo_url: https://github.com/camunda-community-hub/camunda-process-test-coverage/
-edit_uri: edit/develop/docs/
+repo_name: cibseven-community-hub/cibseven-process-test-coverage
+repo_url: https://github.com/cibseven-community-hub/cibseven-process-test-coverage/
+edit_uri: edit/main/docs/
 
 markdown_extensions:
     - attr_list
@@ -40,7 +40,7 @@ theme:
     - navigation.sections
     - navigation.top # add "navigate to top" page icon on bottom left
     - toc.integrate # integrate site TOC into the menu on the left
-  logo: assets/img/camunda-logo.png
+  logo: assets/img/cibseven-logo.png
   icon:
     repo: fontawesome/brands/github
   font:
diff --git a/regression-tests/junit4-platform-7/src/test/java/org/cibseven/community/process_test_coverage/junit4/platform7/spring/InMemProcessEngineConfiguration.java b/regression-tests/junit4-platform-7/src/test/java/org/cibseven/community/process_test_coverage/junit4/platform7/spring/InMemProcessEngineConfiguration.java
@@ -20,7 +20,7 @@
 import org.springframework.transaction.PlatformTransactionManager;
 
 /**
- * Adapted from: https://github.com/camunda/camunda-bpm-platform/blob/master/engine-spring/src/test/java/org/camunda/bpm/engine/spring/test/configuration/InMemProcessEngineConfiguration.java
+ * Adapted from: https://github.com/cibseven/cibseven/blob/main/engine-spring/core/src/test/java/org/cibseven/bpm/engine/spring/test/configuration/InMemProcessEngineConfiguration.java
  */
 @Configuration
 public class InMemProcessEngineConfiguration {
@@ -34,7 +34,7 @@ public DataSource dataSource() {
     SimpleDriverDataSource dataSource = new SimpleDriverDataSource();
 
     dataSource.setDriverClass(org.h2.Driver.class);
-    dataSource.setUrl("jdbc:h2:mem:camunda-test;DB_CLOSE_DELAY=-1");
+    dataSource.setUrl("jdbc:h2:mem:cibseven-test;DB_CLOSE_DELAY=-1");
     dataSource.setUsername("sa");
     dataSource.setPassword("");
 
