release version 0.17.1

typelevel · Mar 19, 2021 · c0d8deb · c0d8deb
1 parent 339a9c7
commit c0d8deb
Show file tree

Hide file tree

Showing 37 changed files with 141 additions and 143 deletions.
diff --git a/README.md b/README.md
@@ -10,11 +10,9 @@ Toolkit for transforming lightweight text markup and template based site and e-b
 Latest Release
 --------------
 
-The latest release is version **0.17.0**.  
+The latest release is version **0.17.1**.  
 
-It is published to Maven Central for Scala 2.13, 2.12 and Scala.js 1.0.
-
-The sbt plugin is published to the sbt plugin repository for sbt 1.x.
+The library is published to Maven Central for Scala 2.13, 2.12 and Scala.js 1.x and the sbt plugin for sbt 1.x.
 
 The last release supporting Scala 2.11 had been 0.10.0, 
 the last release for Scala 2.10 and sbt 0.13 was 0.7.0.

diff --git a/build.sbt b/build.sbt
@@ -6,7 +6,7 @@ val scala2_12 = "2.12.13"
 val scala2_13 = "2.13.5"
 
 lazy val basicSettings = Seq(
-  version               := "0.17.1-SNAPSHOT",
+  version               := "0.17.1",
   homepage              := Some(new URL("http://planet42.github.io/Laika/")),
   organization          := "org.planet42",
   organizationHomepage  := Some(new URL("http://planet42.org")),
@@ -92,7 +92,8 @@ lazy val docs = project.in(file("docs"))
     laikaTheme := ManualSettings.helium,
     laikaConfig := ManualSettings.config,
     laikaExtensions := Seq(GitHubFlavor, SyntaxHighlighting, ManualBundle),
-    Laika / sourceDirectories := Seq(baseDirectory.value / "src")
+    Laika / sourceDirectories := Seq(baseDirectory.value / "src"),
+    Laika / target := baseDirectory.value / "target"
   )
 
 lazy val core = crossProject(JSPlatform, JVMPlatform)

diff --git a/docs/src/02-running-laika/01-sbt-plugin.md b/docs/src/02-running-laika/01-sbt-plugin.md
@@ -21,7 +21,7 @@ supporting that sbt version.
 First add the plugin to `project/plugins.sbt`:
 
 ```scala
-addSbtPlugin("org.planet42" % "laika-sbt" % "0.17.0")
+addSbtPlugin("org.planet42" % "laika-sbt" % "0.17.1")
 ```
 
 Then enable the plugin in your project's `build.sbt`:

diff --git a/docs/src/02-running-laika/02-library-api.md b/docs/src/02-running-laika/02-library-api.md
@@ -19,21 +19,21 @@ If you want to stick to pure transformations from string to string and don't nee
 any of the binary output formats like EPUB or PDF, you are fine with just using the `laika-core` module:
 
 ```scala
-libraryDependencies += "org.planet42" %% "laika-core" % "0.17.0" 
+libraryDependencies += "org.planet42" %% "laika-core" % "0.17.1" 
 ```
 
 This module is also 100% supported for Scala.js, so you can alternatively use the triple `%%%` syntax
 if you want to cross-build for Scala.js and the JVM:
 
 ```scala
-libraryDependencies += "org.planet42" %%% "laika-core" % "0.17.0" 
+libraryDependencies += "org.planet42" %%% "laika-core" % "0.17.1" 
 ```
 
 If you want to add support for file and stream IO and/or output in the EPUB format, 
 you need to depend on the `laika-io` module instead:
 
 ```scala
-libraryDependencies += "org.planet42" %% "laika-io" % "0.17.0" 
+libraryDependencies += "org.planet42" %% "laika-io" % "0.17.1" 
 ```
 
 This depends on `laika-core` in turn, so you always only need to add one module as a dependency and will get
@@ -43,7 +43,7 @@ are in JVM land here.
 Finally PDF support comes with its own module as it adds a whole range of additional dependencies:
 
 ```scala
-libraryDependencies += "org.planet42" %% "laika-pdf" % "0.17.0" 
+libraryDependencies += "org.planet42" %% "laika-pdf" % "0.17.1" 
 ```
 
 Again, this builds on top of the other modules, so adding just this one dependency is sufficient.

diff --git a/docs/src/07-reference/06-release-notes.md b/docs/src/07-reference/06-release-notes.md
@@ -2,6 +2,23 @@
 Release Notes
 =============
 
+0.17.1 (Mar 19, 2021)
+---------------------
+
+* New syntax highlighters for YAML, Haskell, Dhall and Alloy.
+* AST: new companions for list and link types to reduce boilerplate and new `RawLink` type.
+* Reduction of boilerplate in test suites by re-using common directory tree structures.
+* Publish sbt plugin to Maven Central instead of bintray to deal with the impending sunsetting of the latter.
+* Include manual build and GitHub Actions in repository.
+* Bugfixes
+    * Versioning support in Helium theme: fix several issues where versioned path were rendered unversioned
+      and vice versa; affected links to API documentation, e-book downloads and the favicon.
+    * Fix incorrect merging of configuration instances when using `InputTreeBuilder` to manually assemble inputs.
+    * `Path.isSubPath` no longer fails when the only difference is suffix or fragment.
+    * Markdown parser now supports literal spans with multiple backticks as delimiter.
+    * The date directive for reStructured text now excludes the time component by default to align with the spec.
+    * Whitespace before a configuration header in a markup file does no longer prevent detection of the header.
+
 
 0.17.0 (Oct 31, 2020)
 ---------------------

diff --git a/docs/src/olderVersions/reduced.template.html b/docs/src/olderVersions/reduced.template.html
@@ -4,7 +4,7 @@
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="generator" content="Laika 0.17.0 + Helium Theme" />
+    <meta name="generator" content="Laika 0.17.1 + Helium Theme" />
     <title>${cursor.currentDocument.title}</title>
     @:for(laika.site.metadata.authors)
       <meta name="author" content="${_}"/>

diff --git a/io/src/main/resources/laika/helium/templates/default.template.epub.xhtml b/io/src/main/resources/laika/helium/templates/default.template.epub.xhtml
@@ -3,7 +3,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
-    <meta name="generator" content="Laika 0.17.0 + Helium Theme" />
+    <meta name="generator" content="Laika 0.17.1 + Helium Theme" />
     <title>${cursor.currentDocument.title}</title>
     @:for(laika.site.metadata.authors)
       <meta name="author" content="${_}"/>

diff --git a/io/src/main/resources/laika/helium/templates/default.template.html b/io/src/main/resources/laika/helium/templates/default.template.html
@@ -4,7 +4,7 @@
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="generator" content="Laika 0.17.0 + Helium Theme" />
+    <meta name="generator" content="Laika 0.17.1 + Helium Theme" />
     <title>${cursor.currentDocument.title}</title>
     @:for(laika.site.metadata.authors)
       <meta name="author" content="${_}"/>

diff --git a/io/src/main/resources/laika/helium/templates/landing.template.html b/io/src/main/resources/laika/helium/templates/landing.template.html
@@ -4,7 +4,7 @@
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="generator" content="Laika 0.17.0 + Helium Theme" />
+    <meta name="generator" content="Laika 0.17.1 + Helium Theme" />
     <title>${?laika.site.metadata.title}</title>
     @:for(laika.site.metadata.authors)
       <meta name="author" content="${_}"/>

diff --git a/io/src/test/scala/laika/helium/HeliumDownloadPageSpec.scala b/io/src/test/scala/laika/helium/HeliumDownloadPageSpec.scala
@@ -75,7 +75,7 @@ class HeliumDownloadPageSpec extends IOFunSuite with InputBuilder with ResultExt
                      |<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
                      |<meta charset="utf-8">
                      |<meta name="viewport" content="width=device-width, initial-scale=1.0">
-                     |<meta name="generator" content="Laika 0.17.0 + Helium Theme" />
+                     |<meta name="generator" content="Laika 0.17.1 + Helium Theme" />
                      |<title>Downloads</title>
                      |<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700">
                      |<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/tonsky/[email protected]/distr/fira_code.css">

diff --git a/io/src/test/scala/laika/helium/HeliumEPUBHeadSpec.scala b/io/src/test/scala/laika/helium/HeliumEPUBHeadSpec.scala
@@ -16,11 +16,12 @@
 
 package laika.helium
 
-import cats.effect.IO
+import cats.effect.{IO, Resource}
 import laika.api.Transformer
 import laika.ast.{/, Path}
 import laika.ast.Path.Root
 import laika.format.{EPUB, Markdown}
+import laika.io.api.TreeTransformer
 import laika.io.helper.{InputBuilder, ResultExtractor, StringOps}
 import laika.io.implicits._
 import laika.io.model.StringTreeOutput
@@ -29,7 +30,7 @@ import laika.theme._
 
 class HeliumEPUBHeadSpec extends IOFunSuite with InputBuilder with ResultExtractor with StringOps {
 
-  def transformer (theme: ThemeProvider) = Transformer
+  def transformer (theme: ThemeProvider): Resource[IO, TreeTransformer[IO]] = Transformer
     .from(Markdown)
     .to(EPUB.XHTML)
     .io(FileIO.blocker)
@@ -43,7 +44,7 @@ class HeliumEPUBHeadSpec extends IOFunSuite with InputBuilder with ResultExtract
 
   val defaultResult = """<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
                         |<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
-                        |<meta name="generator" content="Laika 0.17.0 + Helium Theme" />
+                        |<meta name="generator" content="Laika 0.17.1 + Helium Theme" />
                         |<title></title>
                         |<link rel="stylesheet" type="text/css" href="helium/laika-helium.epub.css" />""".stripMargin
 
@@ -86,7 +87,7 @@ class HeliumEPUBHeadSpec extends IOFunSuite with InputBuilder with ResultExtract
     )
     val expected = """<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
                      |<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
-                     |<meta name="generator" content="Laika 0.17.0 + Helium Theme" />
+                     |<meta name="generator" content="Laika 0.17.1 + Helium Theme" />
                      |<title></title>
                      |<link rel="stylesheet" type="text/css" href="helium/laika-helium.epub.css" />
                      |<link rel="stylesheet" type="text/css" href="web/foo.shared.css" />""".stripMargin
@@ -106,7 +107,7 @@ class HeliumEPUBHeadSpec extends IOFunSuite with InputBuilder with ResultExtract
       .epub.autoLinkJS(Root / "custom-js")
     val expected = """<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
                      |<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
-                     |<meta name="generator" content="Laika 0.17.0 + Helium Theme" />
+                     |<meta name="generator" content="Laika 0.17.1 + Helium Theme" />
                      |<title></title>
                      |<link rel="stylesheet" type="text/css" href="helium/laika-helium.epub.css" />
                      |<link rel="stylesheet" type="text/css" href="custom-css/foo.shared.css" />""".stripMargin
@@ -120,7 +121,7 @@ class HeliumEPUBHeadSpec extends IOFunSuite with InputBuilder with ResultExtract
     )
     val expected = """<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
                      |<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
-                     |<meta name="generator" content="Laika 0.17.0 + Helium Theme" />
+                     |<meta name="generator" content="Laika 0.17.1 + Helium Theme" />
                      |<title></title>
                      |<meta name="author" content="Maria Green"/>
                      |<meta name="author" content="Elena Blue"/>

diff --git a/io/src/test/scala/laika/helium/HeliumEPUBTocPageSpec.scala b/io/src/test/scala/laika/helium/HeliumEPUBTocPageSpec.scala
@@ -63,7 +63,7 @@ class HeliumEPUBTocPageSpec extends IOFunSuite with InputBuilder with ResultExtr
     val expected = """<head>
                      |<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
                      |<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
-                     |<meta name="generator" content="Laika 0.17.0 + Helium Theme" />
+                     |<meta name="generator" content="Laika 0.17.1 + Helium Theme" />
                      |<title>Contents</title>
                      |<link rel="stylesheet" type="text/css" href="helium/laika-helium.epub.css" />
                      |</head>