3.0.0-rc1 - 2023-07-13

Contributors

This release was made possible through the hard work of the following wonderful contributors (in no special order):

@camminati @RoettingerJ @PacoVK @bit-jkraushaar @Frank-dev20 @windows97 @mh182 @rdmueller @dependabot @sparsick @johthor @srotman @PeterStange

(list was automatically generated by github)

fixes

• #1200: JCenter kills doctoolchain, as Grolifant is not available on Maven Central

• #1198: gravatar eliminates leading 0 from md5 hash

• #1193: exportEA fails since v2.0.5 with an exception

• #395 asciidoctor-diagram: ERROR: Failed to generate image: PlantUML image generation failed

• #455 Force execution to stop with failure on missing image reference

• #621: dtcw - sdkman installation check returns wrong result

• #829: Multiple run of dtcw with docker is failing because of a container name conflict

• #831: fix for generateSite: images-hrefs not correct

• #973: dtcw getJava doesn't work without local

• #1109: docToolchain release notes contain releases twice

• #1031: dtcw ignores installed Java RE when docker is installed - your java version 17 is too new

• #1163: upload to confluence breaks with embedded images

• #1161: publishToConfluence looses the id when generating level 2 page anchors

• various fixes in dtcw, dtcw.ps1:

  • pick the right environment if none provided by the user
  • support of JAVA_HOME which was silently ignored.

• #220 convertToDocx and convertToEpub not working

• Workaround for Confluence new Editor rollout

  • #1184: PublishToConfluence new editor issues and page size
  • #880: publishToConfluence FAILED: Content body cannot be converted to new editor format

• #1053: publishToConfluence: hash is displayed at end of some pages

added

• configure if build should fail on missing images
  • introduces configuration property failOnMissingImages
• introduce generateContent task - AI for docToolchain
• added req42 framework to downloadTemplate task
• added 'FR' as language for arc42
• Antora support (beta), setup a docToolchain project and integrate it as module seamlessly into your existing Antora playbook. See downloadTemplate task for more details.
• added short tutorial about changing the theme of a microsite

changed

• add support for Java 17, drop support for Java 8
• upgrade Gradle to 8.1.1
• upgrade dependencies
  • 'com.athaydes:spock-reports:2.3.2-groovy-3.0'
  • 'com.github.ben-manes.versions:0.46.0'
  • 'com.structurizr:structurizr-dsl:1.30.1'
  • 'com.structurizr:structurizr-export:1.14.0'
  • 'com.structurizr:structurizr-graphviz:2.0.0'
  • 'de.undercouch.download:5.4.0'
  • 'io.pebbletemplates:pebble:3.2.0'
  • 'net.bytebuddy:byte-buddy:1.14.4'
  • 'org.asciidoctor:asciidoctor-gradle-jvm:4.0.0-alpha.1' (remove obsolete cloning of reveal.js)
  • 'org.asciidoctor:asciidoctorj-diagram:2.2.7'
  • 'org.apache.httpcomponents:httpmime:4.5.14'
  • 'org.apache.poi:poi-ooxml:5.2.3'
  • 'org.codehaus.groovy:groovy-xml:3.0.13'
  • 'org.jsoup:jsoup:1.16.1'
  • 'org.junit.jupiter:junit-jupiter-api:5.9.3'
  • 'org.openapitools:openapi-generator-gradle-plugin:6.6.0'
  • 'org.openapi.generator:6.6.0'
  • 'org.spockframework:spock-core:2.3-groovy-3.0'
• dtcw and dtcw.ps1:
  • improve output with hints to guide the user
  • add --version option
  • deprecate getJava with install java
  • add environment variable DTC_CONFIG_FILE to specify a configuration file other than than docToolchainConfig.groovy in the project root folder
• collectIncludes
  • changed regexp to start with ^[A-Za-z] as file name to allow lowercase filenames as well.
  • certain directories are excluded from traversal. Define excludeDirectories in order to skip additional directories.
• doc: replace old URL doctoolchain.github.io occurrences with the new doctoolchain.org
• publishToConfluence
  • support embedded images

Full Changelog: https://github.com/docToolchain/docToolchain/compare/v2.2.1...v3.0.0-rc1

2.2.1 - 2023-03-05

fixes

• use the configured proxy when publishing labels to confluence pages
• #1054 : fix for publishToConfluence was broken in v2.2.0
• #1063 : fix for exportConfluence broken path for partial exports

added

• exportStructurizr Task
• automated tests for dtcw

changed

• automate the use of x86 emulator on apple silicon in dtcw
• updated jBake Markdown extensions and added FENCED_CODE_BLOCKS

2.2.0 - 2023-02-16

changes which need migration:

#937 Confluence publish nested pages by heading

This replaces the settings allInOnePage and createSubPages. Migrate as follows:

• allInOnePage = true is the same as subpagesForSections = 0
• allInOnePage = false && createSubpages = false is the same as subpagesForSections = 1
• allInOnePage = false && createSubpages = true is the same as subpagesForSections = 2

#940 simplify configuration to use preamble heading from h1 instead of configuration

Migrate by removing the setting preambleTitle and set the correct first level heading in the document.

fixes

• fixed whitespace in GH issue template (which leads to errors in htmlSanityCheck)
• fixed ExportMarkdownSpec
• fixed GenerateDeckSpec
• fixed GenerateDeck / Reveal.js
• fixed exportEA hangs by EA v16.1
• fixed exportEA write model notes into models subfolder
• allow numeric ancestorIds for confluence export
• #951 Improve DTC_PROJECT_BRANCH management
• #976 dtcw shows a fatal error when not in git repository
• #978 dtcw.ps1 does not correctly check for java version
• #890 updated documentation on "Self-Contained docToolchain"
• Remove never used analytics.js file from docsy theme

added

• new Task exportConfluence
• Add confluenceBearerToken property
• rubyExtensions configuration
• CZ as language for downloadTemplate
• Enable to use a particular version of DTC from the wrapper by setting the environment variable 'DTC_VERSION' accordingly.
• publishToConfluence: Add possibility to set the page version comment
• exportEAP.vbs: trim notes filename
• exportEAP.vbs: creates for each model a combined notes
• exportEAP.vbs: msg "looking for..." extended for EA 16.1

changed

• switch docker base image from deprecated openJDK 14 to temurin 11
• The publishToConfluence guide now contains 3 modes for authentication (username & password, username & API key, personal access token)
• Improve confluence export performance when only ancestorIds are given
• #937 Confluence publish nested pages by heading
• #683 publishToConfluence with unknown source language
• #940 simplify configuration to use preamble heading from h1 instead of configuration
• Make dtcw (and some other shell executables) shellcheck proof

2.1.0 - 2022-08-15

fixes

• #720 Fix gradlew.bat
• Fixes typo in dtcw.bat for finding the correct local cli command.
• #847 generateHTML & generatePDF documentation improvements
• #851 fix duplicate TOC marker
• #853 Hide site links when not configured
• #873 generateSite: Fix index page location
• #899 dtcw local (bash) executes :help instead of

added

• #692 generateSite: navigation tree instead of a list on the left
• #886 Add the possibility to set maven credentials
• #848 generateSite: add customisation possibilities for the jbake gradle plugin
• #894 custom, project specific Tasks
• #897 collectIncludes: Add options to configure search

changed

• updated available languages for arc42 template
• updated asciidoctorj-diagram to 2.2.3
• added latest version to dtcw

2.0.5 - 2022-03-10

fixes

2022-03-08::

• downloadTemplate: fix encoding for working with powershell
• #821 exportPPT is broken since 2.x

2022-02-25::

• #764 order :jbake-order: numerical

2021-12-20::

• brushed up docs

2021-12-06::

• #712 - publishToConfluence fails when no hash is available for an uploaded image

2022-01-23::

• #757 - CI: Fix problem in ci-scrip

2021-12-06::

• #20 some wget versions throw errors
• #19 the wrapper stops if no java installed but you want to use docker

2021-11-26::

• #18 gradle daemon has memory problems

2021-11-15::

• #696 - exportContributors - not everybody is rendered
• #697 - exportToMarkdown docs are not referenced correctly

added

2021-12-09::

• #714 - Update exportExcel.gradle

2021-11-30::

• #706 - exportEA: Add check if diagrams shall be overwritten

2021-11-13::

• #686 - Add resourceDirs option

changed

2022-03-09::

• upgraded underlying gradle from 6.7.1 to 6.9.2

2022-03-08::

• downloadTemplate: upgraded download plugin
• #817 htmlSanityCheck remove dependency to generateHTML

2022-02-09::

• #795 publishToConfluence: added hint for wrong configuration

2022-01-23::

• #756 exportEA: Add two more items for export

2021-12-23::

• #730 "improve this doc" and "create and issue" links

2021-12-09::

• make build output less noisy - use logger instead of println

2021-12-08::

• changed wording of landing page (thanx to Jody Winter)

2021-12-04::

• changed java download hint from oracle to https://adoptium.net/

2021-11-30::

• refactored config file

2021-11-14::

• refactored jbake template "menu.gsp"

please ignore this release - it is broken

2.0.3 - 2021-11-11

added

• #681 - Please reactivate single page manual on v2.0.x site

fixed

2021-11-10::

• fix #693 - on windows powershell, targetDir is set wrong
• fix #695 - generateSite: toc attributes

2021-11-09::

• fix #690 - previewSite: exception if folder does not exist

2021-11-08::

• fix #687 - wrong encoding of emojis
• fix #688 - htmlSanityCheck: config of sourceDir is wrong
• fix #689 - code highlight: css clash with blog post tags
• fix #682 - generateSite: copyImages uses the wrong target

added

2021-10-19::

• use :jbake-rightcolumnhtml: to add some html to the right column

changed

2021-10-19::

• Add #667 - GH Actions Default Build

2021-10-18::

• Fix #664 - doctoolchain.org link and typos

fixed

2021-10-19::

• fix example for gitRepoUrl in config
• fix projectRootDir
• fix status.png and siteTitle

2021-10-17::

• fix #660 - generateSite: projectRootDir wrong

2021-10-11::

• fix #651 - powershell: broken install when space in user path

2021-10-15::

• fix #658 - generateSite - subsequent runs won't fail with an invalid or missing site theme

added

2021-10-06::

• experimental: globalReferences

changed

2021-10-04::

• fix #616 - exportOpenAPI: Enhance the Confluence Open-API Documentation API to refer to URLs

fixed

2021-10-06::

• fix #636 - theme: larger admonition icons
• fix #649 - generateSite on powershell wrong file-separator

2021-10-04::

• fix #645 - exportJiraIssues: Could not get unknown property 'configFile' for task ':exportJiraIssues' of type org.gradle.api.DefaultTask

2021-09-30::

• fix #632 - generateHTML: broken images with generateHTML

finally, we have a 2.0.0 release! Read more about it in this blog post: https://doctoolchain.github.io/docToolchain/v2.0.x/030_news/2021/2.0.0-release.html