Skip to content

Releases: orchidhq/Orchid

0.17.4

24 Aug 01:38
7118832

Choose a tag to compare

  • Allows to specify the target_commitish for GithubReleasesPublisher with commitish in the publisher config
  • Tweak CSS to make images fit page content boundaries in FutureImperfect theme

0.17.3

24 Aug 00:31
ef84f29

Choose a tag to compare

  • Fixes issue with null CLI parameters when running Orchid with maven plugin

0.17.2

02 Aug 18:54
97913c6

Choose a tag to compare

  • Fixes issue with null CLI parameters when running Orchid with maven plugin

0.17.1

10 Jun 02:42

Choose a tag to compare

  • Fixes Gradle plugin to stay compatible with versions of Gradle before 5.x. Fixes #281

0.17.0

01 Jun 04:19

Choose a tag to compare

Orchid 0.17.0 contains many new and breaking changes, which are briefly outlined in these relase notes. Be sure to review the Migration Guide for a complete list of breaking changes and how to address them.

New Features

  • New "integrations" projects
  • Wiki sections can now be imported from Github and Gitlab project wikis (see integrations above)
  • Sites can now be published to Bitbucket and Gitlab (see integrations above)
  • New Shared Configurations allow user-defined archetype option groups. See full documentation here

Improvements and Bugfixes

  • Netlify Publisher
    • Now handles uploads of really large sites. Previously, deploys of more than a couple thousand pages or so would time out and fail.
    • It can infer the Netlify siteId from the Orchid base URL, and is now an optional property
  • Wikis
    • PDF ebooks generated by Wiki plugin are now included in a Collection, so they can be linked to with the linking functions and in menus
    • Fixed bug creating PDF ebooks for multiple sections
  • Changelogs
    • Adds Archetype to Changelog entries from changelog.allVersions in config.yml
    • Version bumps are inferred from changelog entries, and no longer need to be manually entered
    • Improves formatting of meta/versions.json file. Release notes can now be embedded in this JSON file
  • Other
    • Improves console output of Git-based publishers and Swiftdoc plugin
    • Swiftdoc plugin now accepts a list of source roots to find Swift sources, rather than a single directory
    • .puml file extension is now recognized as a PlantUML file by default
    • Fixed NPE calling a TemplateFunction as a Clog-formatted string
    • Fixes formatting of dates in sitemap XML files so as to not cause warnings from Google indices

0.16.x to 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 Orchid Github 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.17.0 dependency to continue using these features
  • The Netlify publisher has been moved out of OrchidCore and into the Orchid Netlify integration project. Add the io.github.javaeden.orchid:OrchidNetlify:0.17.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

0.16.10

04 May 19:30

Choose a tag to compare

  • Allows use of relative URLs as a base URL
  • Update Pebble to 3.0.9, with support for embed tag

0.16.9

13 Apr 22:25
ef7abf0

Choose a tag to compare

  • Allows "/" to be properly used as a base URL
  • Adds baseUrl and homepageUrl filters to avoid directly using site.baseUrl in templates, which doesn't work correctly with URLs ending with "/"
  • improves error-reporting for syntax errors in Pebble templates and YAML config files

0.16.8

05 Apr 15:51

Choose a tag to compare

  • "Delombok" entire project (#249, thank you @Sumo99!)
  • Makes Gradle tasks discoverable with gradlew --tasks (#256)
  • Properly render link tags from Javadoc comment text (#251)
  • Build pipeline now fails if GithubPagesPublisher fails to push to remote (#238)

0.16.7

22 Mar 19:36

Choose a tag to compare

  • Fixes issues rendering PlantUML diagrams

0.16.6

18 Mar 20:06

Choose a tag to compare

  • Allows Changelog entries to be annotated with additional data referencable from templates
  • Removed Google Plus from social model since the service is shutting down