lightbend / sbt-paradox-project-info

A Paradox directive to include standardised project information into the generated documentation
Apache License 2.0
5 stars 5 forks source link

Make ReadinessLevel's configurable #34

Closed mdedetrich closed 2 years ago

mdedetrich commented 2 years ago

Removes Lightbend hardcoded values for readinessLevel's and allows them to be configurable. This is done by adding a new sbt key called readinessLevels which is a Map[String, ReadinessLevel] where the String is the config key in project-info.conf and the value is a Scala type that implements ReadinessLevel. I decided to make this confgurable via sbt settings instead of typesafe config because the typesafe config inheritance doesn't via nested projects doesn't work with sbt plugins (ontop of this defining the html rendering via name in hoconf is not that nice).

In order to test that this is actually working properly, I created a sample https://github.com/mdedetrich/sbt-paradox-lightbend-project-info and using sbt localPublish along with temporarily setting the version to -SNAPSHOT I republished https://github.com/akka/akka-paradox locally to test it with https://github.com/akka/alpakka docs/makeSite. Note that https://github.com/mdedetrich/sbt-paradox-lightbend-project-info implements the sbt-plugin to automatically trigger when you include it as a dependency (the alternative is to use noTrigger which means you manually have to enable it with .enablePlugins(LightbendParadoxInfoPlugin)).

This means that once this pull request and released the following things to need to be done

Resolves: https://github.com/lightbend/sbt-paradox-project-info/issues/17

mdedetrich commented 2 years ago

Thanks for the merge, let me know when a a new release is made and what you plan to do regarding https://github.com/mdedetrich/sbt-paradox-lightbend-project-info

ennru commented 2 years ago

Releasing has started and I created and (so far) empty https://github.com/lightbend/sbt-paradox-lightbend-project-info.

mdedetrich commented 2 years ago

@ennru So it turns out you cannot fork an empty repo https://stackoverflow.com/questions/39013301/how-do-i-fork-an-empty-repository-on-github . Can you just add a LICENSE file and then I can add the rest?

ennru commented 2 years ago

I pushed the contents from your repo there.

mdedetrich commented 2 years ago

Perfect thanks, just created a PR on https://github.com/lightbend/sbt-paradox-lightbend-project-info/pull/1 that points to this new release.