Added 00-docs CONFIG/VERSIONS files in CompanyDocsGenerator.

Author: pme123

04-helper/src/main/scala/camundala/helper/dev/company/CompanyDocsGenerator.scala

@@ -2,23 +2,31 @@ package camundala.helper.dev.company
 
 import camundala.helper.dev.update.createIfNotExists
 
-case class CompanyDocsGenerator (companyCamundala: os.Path):
-  private lazy val docs = companyCamundala / s"00-docs" / "src" / "docs"
+import java.time.LocalDate
+
+case class CompanyDocsGenerator(companyCamundala: os.Path):
+  private lazy val docsBase = companyCamundala / s"00-docs"
+  private lazy val docsSrc = docsBase / "src" / "docs"
 
   lazy val generate: Unit =
-        println("Generate Company Docs")
-        // generate docs
-        directory("dependencies", "Dependencies", isVersioned = true)
-        directory("helium", "Helium", isVersioned = false)
-        contact
-        instructions
-        favicon
-        pattern
-        statistics
-        style
+    println("Generate Company Docs")
+    // generate docs
+    directory("dependencies", "Dependencies", isVersioned = true)
+    directory("helium", "Helium", isVersioned = false)
+    contact
+    instructions
+    favicon
+    pattern
+    statistics
+    style
+    config
+    versions("VERSIONS")
+    versions("VERSIONS_PREVIOUS")
+  end generate
 
   private lazy val contact =
-    createIfNotExists(docs / "contact.md",
+    createIfNotExists(
+      docsSrc / "contact.md",
       s"""|## Contact
           |If you have questions, spot a bug or you miss something, please let us know🤓.
           |
@@ -29,7 +37,8 @@ case class CompanyDocsGenerator (companyCamundala: os.Path):
           |""".stripMargin
     )
   private lazy val instructions =
-    createIfNotExists(docs / "instructions.md",
+    createIfNotExists(
+      docsSrc / "instructions.md",
       s"""|## Create This Page
           |This is a semi-automatic process. This should be done either to prepare a Release or after a Release.
           |
@@ -40,7 +49,8 @@ case class CompanyDocsGenerator (companyCamundala: os.Path):
     )
 
   private lazy val pattern =
-    createIfNotExists(docs / "pattern.md",
+    createIfNotExists(
+      docsSrc / "pattern.md",
       s"""|# Process Pattern
           |We try to establish Patterns for doing the same tasks.
           |This documentation lists them and gives you some examples.
@@ -49,17 +59,20 @@ case class CompanyDocsGenerator (companyCamundala: os.Path):
           |""".stripMargin
     )
   private lazy val statistics =
-    createIfNotExists(docs / "statistics.md",
+    createIfNotExists(
+      docsSrc / "statistics.md",
       s"""|# Process Statistics
           |
           |The Process Statistics you find new in Camunda Optimize.
           |
           |TODO - Create here a link to the Optimize Dashboard or add some statistics manually.
           |
           |<iframe id="optimizeFrame" src="https://TODO/" frameborder="0" style="width: 1000px; height: 700px; allowtransparency; overflow: scroll"></iframe>
-          |""".stripMargin)
+          |""".stripMargin
+    )
   private lazy val style =
-    createIfNotExists(docs / "style.md",
+    createIfNotExists(
+      docsSrc / "style.md",
       s"""|.mermaid svg {
           |    height: 400px;
           |}
@@ -68,24 +81,65 @@ case class CompanyDocsGenerator (companyCamundala: os.Path):
           |    margin-right: 40px;
           |    width: 400px;
           |}
-          |""".stripMargin)
+          |""".stripMargin
+    )
 
   private lazy val favicon =
-    val faviconPath = docs / "favicon.ico"
+    val faviconPath = docsSrc / "favicon.ico"
     if !os.exists(faviconPath) then
       os.write(faviconPath, (os.resource / "favicon.ico").toSource)
 
   private def directory(name: String, title: String, isVersioned: Boolean) =
-    os.makeDir.all(docs / name)
-    createIfNotExists(docs / name / "directory.md",
+    os.makeDir.all(docsSrc / name)
+    createIfNotExists(
+      docsSrc / name / "directory.md",
       s"""|${laikaVersioned(isVersioned)}
-        |
-        |${laikaTitle(title)}
-        |
-        |$laikaNavigationOrder
-        |""".stripMargin
+          |
+          |${laikaTitle(title)}
+          |
+          |$laikaNavigationOrder
+          |""".stripMargin
     )
+  end directory
 
   private def laikaVersioned(isVersioned: Boolean) = s"laika.versioned = $isVersioned"
   private def laikaTitle(title: String) = s"laika.title = $title"
   private lazy val laikaNavigationOrder = s"laika.navigationOrder = [\n]"
+
+  private lazy val config =
+    createIfNotExists(
+      docsBase / "CONFIG.conf",
+      s"""|// year and month you want to release
+          |release.tag = "${LocalDate.now().toString.take(7)}"
+          |// a list with existing Releases on the web server
+          |releases.older = []
+          |// flag of this is for the release or just from the TST to see what is going on.
+          |released = true
+          |// this is the url of the release planing, e.g. Jira
+          |jira.release.url = "https://yourReleasePage/versions/64209"
+          |// who is responsible for the Release
+          |release.responsible {
+          |  name = "Peter Blank"
+          |  date = "CHANGE to release date"
+          |}
+          |// what is the release about (abstract as markup)
+          |release.notes = \"\"\"
+          |- TODO: Describe the Release here
+          |""".stripMargin
+    )
+  private def versions(name: String) =
+    createIfNotExists(
+      docsBase / s"$name.conf",
+      s"""|// START VERSIONS
+          |
+          |myProjectWorkerVersion = "1.0.0"
+          |//..
+          |
+          |// END WOKRER
+          |
+          |myProjectVersion = "1.0.3"
+          |//..
+          |
+          |// END VERSIONS
+          |""".stripMargin)
+end CompanyDocsGenerator