Skip to content

Latest commit

 

History

History
766 lines (564 loc) · 29.5 KB

changelog.adoc

File metadata and controls

766 lines (564 loc) · 29.5 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project tries to adhere to Semantic Versioning.

Unreleased

fixes

added

changed

3.1.2 - 2023-11-16

added

changed

  • The Confluence API configuration is now aware of contexts and hides the API version specific settings.

3.0.1 - 2023-09-11

fixes

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

3.0.0-rc1 - 2023-07-13

fixes

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

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

fixes

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

2.1.0 - 2022-08-15

changed

2022-05-08
  • updated available languages for arc42 template

2022-08-07
  • updated asciidoctorj-diagram to 2.2.3

2022-08-09
  • added latest version to dtcw

2.0.5 - 2022-03-10

changed

2022-03-09
  • upgraded underlying gradle from 6.7.1 to 6.9.2

2022-03-08
2022-02-09
2022-01-23
2021-12-23
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
2021-11-30
  • refactored config file

2021-11-14
  • refactored jbake template "menu.gsp"

2.0.4 - 2022-03-09

there was a major bug in this release, please ignore

2.0.2 - 2021-10-19

added

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

fixed

2021-10-19
  • fix example for gitRepoUrl in config

  • fix projectRootDir

  • fix status.png and siteTitle

2021-10-17
2021-10-11
2021-10-15

2.0.0 - 2021-09-23

The 2.0.0 relase contains all changes of the release candidates. See "v2.0.0 of docToolchain has been released!" for more details.

2.0.0-rc17 - 2021-09-22

changed

2021-09-22
  • streamingExecute (exportPPT, exportEA) now emits a note instead ot an error when running on linux

  • brushed up powershell wrapper

2.0.0-rc16 - 2021-09-21

added

2021-09-21
  • added lunrjs as local search engine

fixed

2021-09-21
  • updated exportContributors to follow moved files

  • fixed downloadTemplate

2.0.0-rc15 - 2021-09-18

added

2021-09-06
  • added warning when running on WSL

  • added dtcw.bat to avoid execution restrictions

  • updated developer docs

  • added docsy as theme

fixed

2021-09-18
  • fixed favicons

  • fixed blog

2.0.0-rc14 - 2021-05-22

added

2021-05-21
  • if the outputPath from the config starts with a '/', it will be considered as absolute path.
    This way, you can move the build fodler outside of your repository.
    outputPath = System.getenv('HOME')'/.doctoolchain/build/'(new File('.')).canonicalPath.md5()

  • repository theme gets only copied to build if it is defined in siteFolder

  • generateSite will now add meta-data to all asciidoc files which have no meta-data defined. The menu name and order will be created corresponding to the folder and file name. The title will be extracted as first headline from the file itself.

2021-05-18
  • Headless mode for themes

  • fix landing page (only gets copied once when microsite config isn’t set yet.)

changed

fixed

2021-05-22
  • fix copyThemes to also copy the external theme

2021-05-06
  • fix #574: publishToConfluence: Problem with wrong ancestorId

2021-04-28
  • fix copyImages for generateSite

1.4.0 - 2021-05-21

Added

2021-05-21
  • removed jCenter references

2021-03-21

Fixed

2021-05-06
  • fix #574: publishToConfluence: Problem with wrong ancestorId

2021-04-29
  • exportEA hang after all exports are done since EA v15.2 #570 (PeterStange)

Version: 2.0.0-rc13

added

2021-04-07
  • generateSite can now handle themes

2021-04-09
  • downloadTemplate can now handle further templates

Version: 2.0.0-rc4

fixed

2012-03-02
  • removed default imagesdir for generateSite

Version: 2.0.0-rc3

fixed

2012-03-01
  • fixed imagesdir typo

Version: 2.0.0-rc2

fixed

2012-03-01
  • updated docs for generateSite

  • fixed menu for generateSite

2012-02-27
  • fixed createDist task

  • fixed plantUML for generatePDF

  • fixed plantUML for generateSite

Version: 2.0.0-rc1

added

2012-02-26
  • copyThemes task

  • generateSite task

2021-02-23
  • first version of powershell wrapper

2021-02-22
  • manual test script

2021-01-05
  • dtc wrapper

2021-01-08
  • first definition of a static site taken from arc42-template-project

  • updated gradle wrapper (6.6.1)

  • added downloadTemplates task

  • added feature to automatically create a Config file if it doesn’t exist

  • configured gradle to run without daemon

fixed

2021-02-24
  • [543] dtcw: added pre-requisites check and alternative curl instead of wget

2021-02-22
  • handling of images for generateHTML

Version 1.3.1

Added

Changed

Fixed

2021-02-28
  • doctoolchain.bat can now handle java properties

1.3.1 - 2021-02-27

Added

2021-01-29
  • [519] - Describe release process, update changelog

  • smaller distribution file through createDist task

2021-01-26
  • [522] - Added sdkman file

2021-01-25
  • [522] - Support for JDK 14

  • [514] - Add support of multiple EA project locations in parallel

Changed

2021-01-25
  • Add support of multiple EA project locations in parallel #514

  • updated Gradle to 6.7.1

  • added JDK14 for travis-ci testing

  • [517] - update revealJs to 3.9.1 and asciidoctor-revealjs to 2.0.1

Fixed

2021-02-22: - [535] - add initArc42RU task 2021-02-10: - [530] - fix writing of diagram attributes using exportEA

2021-01-25
  • [523] - fix for generateDeck

2021-01-25
  • fixed docs: ConfluenceConfig.groovy missing #492

1.3.0 - 2021-01-20

Added

2021-01-05
  • Add properties for htmlSanityCheck #507

2020-09-07
  • Ability to export Jira Sprint(s) data changelog (key, summary) (#473)

1.2.0 - 2020-02-09

Added

2020-08-24
  • Ability to export OpenAPI specification to asciidoc (#464)

2020-08-20
  • New attribute 'ancestorName' for easier nesting in Confluence (#460)

2020-07-08
  • Jira configuration for multiple request to Jira API

  • Saving Jira results to Excel files

  • Basic support for custom fields in Jira results

2020-05-08
  • Jira configuration refactoring to Config.groovy

2019-05-21
  • first version of EA-PlantUML Exchange scripts

2019-02-26
2019-03-08
  • Add TomTom logo as company who uses docToolchain PR#284

1.1.0 - 2020-08-31

Added

2020-08-06

Changed

2019-05-09
  • upgraded to run with JDK11

    • upgraded Gradle to 5.3.1

    • upgraded Groovy to 2.5.4 (comes with Gradle 5.4.1)

    • upgraded Spock to 1.3

2019-03-13
  • prependFilename

    • fixed proper handling of file encoding

    • brushed up logging

    • config., _config., feedback., _feedback. are excluded

2019-03-08
  • asciidoc2confluence

    • added output where docs are published to and added better error message in case of failing authorization 1bc146c

2019-03-06
  • collectIncludes

    • changed regexp to accept ^[A-Z]{3,}-.*$ as file name, eg. all Files which start with an upper case word of at least 3 chars followed by a dash

    • fixed sourceFolder to work with docToolchain as submodule

    • added better console output

    • skip docToolchain-folder if used as submodule

Fixed

2021-25-01
  • fixed docs: ConfluenceConfig.groovy missing #492

2019-05-30
  • fix publishToConfluence internal link targets (#223)

2019-05-09
  • fixed .bat (#305)

  • fixed tests (#307)

2019-03-08
  • asciidooc2confluence

    • #227 spaceKey was ignored PR#297

Released

2020-08-06