From 4e453bb3750888ae57f4fcefa0c2bdf06c8d7c7a Mon Sep 17 00:00:00 2001 From: Sebastian Wolf <65733509+phanlezz@users.noreply.github.com> Date: Tue, 29 Oct 2024 10:02:20 +0100 Subject: [PATCH 1/2] tech: update section in the version bumping readme for windows --- VERSION_BUMPING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VERSION_BUMPING.md b/VERSION_BUMPING.md index b86aaec234..f4997d7df0 100644 --- a/VERSION_BUMPING.md +++ b/VERSION_BUMPING.md @@ -17,7 +17,7 @@ For the Visualization release, the project must be built, so it is advisable to ## Start the automatic release process - Call `pipenv run make_release`. -- On Windows it is recommended to run the command in `cmd.exe` rather than in a git bash. +- **On Windows**: Make sure that the git bash utilities are on your path variable if you are using the `cmd`. Alternatively, you can use the git `bash` directly. - Check the release process on GitHub after the script is completed > You can add `-f` or `--force` to disable the protections of the script. You can't release in force mode. From 0478a0bdc639ed36bd926c5140900e705f8166cb Mon Sep 17 00:00:00 2001 From: Sebastian Wolf <65733509+phanlezz@users.noreply.github.com> Date: Tue, 29 Oct 2024 10:13:45 +0100 Subject: [PATCH 2/2] tech: add section about bash tools to the start guide and visualization readme --- DEV_START_GUIDE.md | 2 +- visualization/README.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/DEV_START_GUIDE.md b/DEV_START_GUIDE.md index 11ecca0dda..eb14a29812 100644 --- a/DEV_START_GUIDE.md +++ b/DEV_START_GUIDE.md @@ -15,7 +15,7 @@ All major decisions are documented in our [architecture decision records (ADR)]( To work on CodeCharta, please ensure your system includes: -- Git +- Git (with bash utilities for Windows) - Java >= 11, <= 21 - Node >= 20 diff --git a/visualization/README.md b/visualization/README.md index d31e85dca3..f3b554210f 100755 --- a/visualization/README.md +++ b/visualization/README.md @@ -57,6 +57,8 @@ $ codecharta-visualization > To clone and run this application, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (version >=20) installed +> (Windows) For some tasks the Git bash utilities are required + ```bash # Clone the CodeCharta repo $ git clone https://github.com/MaibornWolff/codecharta.git