0.17.0 Migration Guide


0.17.0 Migration Guide

  • The key for the Github Pages publisher has renamed. Change ghPages to githubPages in your config.yml publication pipeline
  • The baseDir property in Swiftdoc plugin configuration has been changed to sourceDirs to match other code-doc plugins, and now accepts either a single String or a list of Strings as a value.
  • The Github Pages publisher has been moved out of OrchidCore and into the OrchidGithub integration project. Likewise, the Github Releases publisher has been moved from OrchidChangelog to OrchidGithub, and the githubProject() global collection has been moved from OrchidCopper to OrchidGithub. Add the io.github.javaeden.orchid:OrchidGithub:0.21.0 dependency to continue using these features
  • The Netlify publisher has been moved out of OrchidCore and into the OrchidNetlify integration project. Add the io.github.javaeden.orchid:OrchidNetlify:0.21.0 dependency to continue using the Netlify publisher
  • The following "spells" supported by Clog have been removed: [ baseUrl, baseUrlScheme, baseUrlHost, baseUrlPort, baseUrlRoot, version, orchidVersion, env ] . Instead, use the normal TemplateFunctions within Clog-formatted strings for baseUrl, and create TemplateFunctions for your site as a local plugin if your need the other Clog spells
  • The changelogVersionPicker component has been removed, as it has not worked for quite a while. You should create this component yourself using Javascript to match your theme
  • Notable dependency changes
    • Flexmark Extensions have changed packages. Custom Flexmark extensions now must be of the type com.vladsch.flexmark.util.builder.Extension