comsysto / livingdoc

Living Documentation Lab
MIT License
17 stars 5 forks source link

Release? #12

Open thoralfrickert-wendtsda opened 2 years ago

thoralfrickert-wendtsda commented 2 years ago

Hello,

we started to use your library in combination with our backstage.io documentation to create dynamically PlantUML diagrams of our API models. In the current process of CI/CD with Gradle we found a very complicated way to integrate LivingDoc in the build process. But I wonder if it is possible to create a release from the current state of this repo. It doesnt need to be a 1.0.0 release, a 0.1.0 is enough.

From our point of view, the library works as expected. And as a MVP it would be ok.

With best regards

thoralfrickert-wendtsda commented 2 years ago

Currently we do

subprojects {
    apply plugin: 'java'
    ...

    project.ext {
        livingdocVersion = "master-SNAPSHOT"
        ...
    }

    sourceCompatibility = JavaVersion.VERSION_17
    version = System.getenv('SEMANTIC_VERSION')

    repositories {
        mavenCentral()
        maven { url "https://jitpack.io" }
        ...
    }

    dependencies {
      ...
      compileOnly "com.github.comsysto.livingdoc:s0t-annotations:${livingdocVersion}"

      annotationProcessor "com.github.comsysto.livingdoc:s0t-processors:${livingdocVersion}"

    }

    tasks.withType(JavaCompile) {
      options.encoding = 'UTF-8'
      options.compilerArgs.addAll([
          "-As0t.src.dir=${project.projectDir}/src/main/java",
          "-As0t.out.dir=${project.rootDir}/docs/plantuml/generated/${project.name}",
          "-As0t.freemarker.template.root=${project.rootDir}/docs/plantuml/templates"
      ])
    }

}

But this looks "argful" complicated for the only necessary compileOny/annotationOnly which is currently running thru jitpack.io. It works, but it's not nice - and only because of a missing release.