Skip to content

Commit

Permalink
dtcw: closes docToolchain#1031, improve output to guide the user
Browse files Browse the repository at this point in the history
- Fix bug docToolchain#1031
- Fix: support of JAVA_HOME which was silently ignored.
- Add `--version` option
- dtcw API change: use explicit 'install' command to install
  components locally.
- Improve output: provide the concept of 'environments'.
- Show deprecation of 'getJava'
- Skip 'install doctoolchain' if already installed

Refactorings:
- Replace boolean flags which `available_environments` and `dtc_installations`.

Tests:
- Use mocks for dtcw test suite to improve performance.
- Added end-to-end tests for installation in 'local' and 'sdk'
  environments.
  • Loading branch information
mh182 committed Apr 26, 2023
1 parent dd8750f commit 4d7e63a
Show file tree
Hide file tree
Showing 23 changed files with 1,749 additions and 812 deletions.
15 changes: 15 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,18 @@
[submodule "resources/asciidoctor-reveal.js"]
path = resources/asciidoctor-reveal.js
url = https://github.com/asciidoctor/asciidoctor-reveal.js
[submodule "test/bats"]
path = test/bats
url = https://github.com/bats-core/bats-core.git
[submodule "test/test_helper/bats-support"]
path = test/test_helper/bats-support
url = https://github.com/bats-core/bats-support.git
[submodule "test/test_helper/bats-assert"]
path = test/test_helper/bats-assert
url = https://github.com/bats-core/bats-assert.git
[submodule "test/test_helper/bats-file"]
path = test/test_helper/bats-file
url = https://github.com/bats-core/bats-file.git
[submodule "test/test_helper/bats-mock"]
path = test/test_helper/bats-mock
url = https://github.com/mh182/bats-mock.git
18 changes: 13 additions & 5 deletions changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,24 @@ and this project tries to adhere to https://semver.org/spec/v2.0.0.html[Semantic

=== fixes

* fix decision tree for `dtcw.ps1`
* #831 : fix for generateSite: images-hrefs not correct
* #1109 : docToolchain release notes contain releases twice
* https://github.com/docToolchain/docToolchain/issues/621[#621: dtcw - sdkman installation check returns wrong result]
* https://github.com/docToolchain/docToolchain/issues/831[#831: fix for generateSite: images-hrefs not correct]
* https://github.com/docToolchain/docToolchain/issues/973[#973: `dtcw getJava` doesn't work without `local`]
* https://github.com/docToolchain/docToolchain/issues/1109[#1109: docToolchain release notes contain releases twice]
* https://github.com/docToolchain/docToolchain/issues/1031[#1031: dtcw ignores installed Java RE when docker is installed - your java version 17 is too new]
* various fixes in `dtcw`, `dtcw.ps1`:
** fix decision tree for `dtcw.ps1`
** support of JAVA_HOME which was silently ignored.

=== added

=== changed

* brushed up some hints when running `dtcw.ps1` and `dtcw`
* add environment variable `DTC_CONFIG_FILE` in `dtcw` and `dtcw.ps1` to specify a configuration file other than than `docToolchainConfig.groovy` in the project root folder.
* `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.
Expand Down

0 comments on commit 4d7e63a

Please sign in to comment.