Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Total makeover: split into modules per generator #203

Merged
merged 8 commits into from
Jan 11, 2023
Merged

Conversation

ennru
Copy link
Contributor

@ennru ennru commented Dec 23, 2022

Split into separate plugins per site generator to avoid dependency overload in the using sbt builds.
Both Scala XML and Scala Parser Generators appear in dependencies, many very outdated and likely unmaintained.

Not all perviously supported site generators are prepared in this PR.

Available are:

  • Asciidoctor
  • GitBook
  • Paradox

Docs still need work to reflect the new structure better.

Another dimension in dependency hell is that sbt-ghpages depends on sbt-site 1.4.4 (not obvious to me why). With sbt-site moving to a different group ID (com.github.sbt) that might create unexpected effects.

Split into separate plugins per site generator to avoid dependency overload in
the using sbt builds.
@ennru ennru marked this pull request as ready for review January 11, 2023 13:53
@ennru
Copy link
Contributor Author

ennru commented Jan 11, 2023

This split makes dependency hell slightly cooler and I have tested the Paradox taste on some Akka projects locally. I intend to merge and release this as 1.5.0-RC2.

Copy link

@johanandren johanandren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

The `previewSite` plugin does not enable itself anymore, you need to explicitly enable the parts of sbt-site you need on the sbt project/module containing the documentation. To allow `previewSite` with Paradox for example
```scala
.enablePlugins(SitePreviewPlugin, ParadoxSitePlugin)
```

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add something about the deprecated/no longer working modules here as well?

@ennru ennru changed the title Total makeover: split into modules Total makeover: split into modules per generator Jan 11, 2023
@ennru ennru merged commit 5ebc21d into sbt:main Jan 11, 2023
@ennru ennru deleted the ennru-split branch January 11, 2023 14:26
Comment on lines +5 to +9
addSbtPlugin(
("com.github.sbt" % "sbt-ghpages" % "0.7.0")
// sbt-ghpages depends on sbt-site 1.4.1, which pulls Scala XML 1.x
.exclude("org.scala-lang.modules", "scala-xml_2.12")
)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants