From ea21625a1e73bba3bebccb6ea9c0d5c25d466b18 Mon Sep 17 00:00:00 2001 From: moritz-suckow Date: Mon, 22 May 2023 15:48:43 +0200 Subject: [PATCH 1/9] Start restructuring #3306 --- analysis/README.md | 6 +++++- gh-pages/_docs/07-01-new-to-code.md | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/analysis/README.md b/analysis/README.md index a47ca42d44..01a92d7691 100644 --- a/analysis/README.md +++ b/analysis/README.md @@ -53,6 +53,8 @@ Components that export data from visualisation data to other formats. - Bash or similar - JRE 8-11 (Oracle Java or OpenJDK) +# Installation + ## Installation via npm This installs all binaries to run the analysis. Java 11 is recommended, while Java 8 is still supported. @@ -61,7 +63,7 @@ This installs all binaries to run the analysis. Java 11 is recommended, while Ja To run it you can call `ccsh` -## Installation +## Manual Installation - Download / build package - Unzip / untar package in desired destination folder (named CC_INSTALL_DIR) @@ -72,6 +74,8 @@ To run it you can call `ccsh` - Enter `ccsh` and press `TAB` to see available commands - Enter `ccsh -` and press `TAB` to see available parameters +# Getting Started (?) + ## Build Via gradle: diff --git a/gh-pages/_docs/07-01-new-to-code.md b/gh-pages/_docs/07-01-new-to-code.md index 2d4c941fb3..6aa8c1f893 100644 --- a/gh-pages/_docs/07-01-new-to-code.md +++ b/gh-pages/_docs/07-01-new-to-code.md @@ -14,8 +14,8 @@ When updating your branch, we prefer using a rebase instead of merging to keep t # Code Style Guide -Besides the rules enforced by our linter, we do not follow a set of defined style guidelines for our code. -Just try to make your code readable and follow common best practices. +Besides the rules enforced by our linter, we generally do not follow a set of defined style guidelines for our code. +For the analysis there is an XML file containing a few style rules for your IDE, you can find out more about that in the analysis readme. # GitHub Actions From 2e72b1bf83e1d273ec644706e0fe37ef733d13b4 Mon Sep 17 00:00:00 2001 From: moritz-suckow Date: Tue, 23 May 2023 18:13:27 +0200 Subject: [PATCH 2/9] Add docker usage examples and restructure docs #3306 --- analysis/README.md | 22 ++++++++++++++++++- gh-pages/_data/navigation.yml | 4 ++-- ...ntainers.md => 01-04-docker-containers.md} | 0 visualization/README.md | 12 ++++++++++ 4 files changed, 35 insertions(+), 3 deletions(-) rename gh-pages/_docs/{05-06-docker-containers.md => 01-04-docker-containers.md} (100%) diff --git a/analysis/README.md b/analysis/README.md index 01a92d7691..f0a87a9de0 100644 --- a/analysis/README.md +++ b/analysis/README.md @@ -55,6 +55,13 @@ Components that export data from visualisation data to other formats. # Installation +You can start with **Codecharta Analysis** on multiple ways: + +- Installation as a [npm package](#installation-via-npm) (Recommended) +- Use our [Docker Image](#installation-via-docker) to run the analysis in a container +- Use [docker-compose]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}) to run this with all other containers +- Download the SourceCode and [build it yourself](#manual-installation) + ## Installation via npm This installs all binaries to run the analysis. Java 11 is recommended, while Java 8 is still supported. @@ -63,6 +70,19 @@ This installs all binaries to run the analysis. Java 11 is recommended, while Ja To run it you can call `ccsh` +## Installation via Docker + +You can use this via docker compose or as a standalone container. This section will deal with how to use the analysis as a standalone container. For information on how to use this with docker compose, please check out [Docker Getting Started]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}) +We assume that you already installed docker, if not, you have to do that before! + +To containerize the analysis, please follow the below listed steps. + +- Navigate into the directory you want to analyse with CodeCharta. There are multiple ways to use the docker image: + 1. Start the docker container and a bash shell in it with `docker run -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis bash` (for that to work you have to make sure bash is added to your PATH). This runs the image and mounts the current directory and sets it as the working directory in the image. You can now use the CodeCharta shell or any other of the installed tools via the command line. + 2. Start the docker container and directly use some command (like the ccsh): `docker run -it -v $(pwd):$(pwd) -w $(pwd) codecharta-analysis ccsh`. This starts the Ccsh without any commands, which will open the parser suggestions. + 3. Start the docker container and directly use a specific parser: `docker run -it -v $(pwd):$(pwd) -w $(pwd) codecharta-analysis ccsh rawtextparser .`. This starts the RawTextParser in the current working directory in a container. +- After analysing, you can copy any results with `docker cp codecharta-analysis:/root/fileName.cc.json fileName.cc.json` to your current working directory (replace `/root/` with correct path if file is not in root in container) + ## Manual Installation - Download / build package @@ -74,7 +94,7 @@ To run it you can call `ccsh` - Enter `ccsh` and press `TAB` to see available commands - Enter `ccsh -` and press `TAB` to see available parameters -# Getting Started (?) +# Other ## Build diff --git a/gh-pages/_data/navigation.yml b/gh-pages/_data/navigation.yml index 8ad1b4ff44..0ff21d4938 100644 --- a/gh-pages/_data/navigation.yml +++ b/gh-pages/_data/navigation.yml @@ -15,6 +15,8 @@ docs: url: /docs/quick-start-guide/ - title: "Installation" url: /docs/installation/ + - title: "Docker Containers" + url: /docs/docker-containers/ - title: "Versioning" url: /docs/versioning/ - title: "Price" @@ -38,8 +40,6 @@ docs: url: /docs/custom-metrics/ - title: "Analyze with SonarQube" url: /docs/analyze-with-sonarqube/ - - title: "Docker Containers" - url: /docs/docker-containers/ - title: Analysing-Tools children: diff --git a/gh-pages/_docs/05-06-docker-containers.md b/gh-pages/_docs/01-04-docker-containers.md similarity index 100% rename from gh-pages/_docs/05-06-docker-containers.md rename to gh-pages/_docs/01-04-docker-containers.md diff --git a/visualization/README.md b/visualization/README.md index ae76859920..f591bad9ec 100755 --- a/visualization/README.md +++ b/visualization/README.md @@ -19,6 +19,8 @@ You can start with **Codecharta Visualization** on multiple ways: - Installation as a [npm package](#npm-package) (Recommended) - Run an operating system specific [standalone](#run-a-standalone) - Build it yourself from the github [repository](#build-it-yourself) +- Use [docker-compose]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}) to run this with all other containers +- Use our [Dockerfile](#run-in-docker-container) to run the visualization in a container - Try out the [online version](https://maibornwolff.github.io/codecharta/visualization/app/index.html?file=codecharta.cc.json&file=codecharta_analysis.cc.json) > Be aware, that if you are on Apple Silicon, you need to do additional config for npm installation @@ -140,6 +142,16 @@ $ npm run e2e:auto > To follow/watch the steps the e2e test is performing, deactivate headless mode in `jest-puppeteer.config.js` (and maybe set the `slowMo` parameter) +## Run in Docker container + +You can use this via docker compose or as a standalone container. This section will deal with how to use the visualization as a standalone container. For information on how to use this with docker compose, please check out [Docker Getting Started]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}) +We assume that you already installed docker, if not, you have to do that before! + +To containerize the visualization, please follow the below listed steps. + +- Start the docker container: `docker run -d -p 80:9000 codecharta/codecharta-visualization`. This detaches the container and exposes port 80 on the container and port 9000 on the host. +- Open `localhost:9000` in your browser and you can already use the visualization! + # JSON structure [Example Data](/visualization/app/codeCharta/assets/sample1.cc.json) From 1d460bd664f6f5a1f5058c71d28edc8c6e1cf0df Mon Sep 17 00:00:00 2001 From: moritz-suckow Date: Wed, 24 May 2023 15:22:11 +0200 Subject: [PATCH 3/9] Add changelog entry #3306 --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4e4868853b..c418925d35 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/) ## [unreleased] (Added 🚀 | Changed | Removed 🗑 | Fixed 🐞 | Chore 👨‍💻 👩‍💻) +### Added 🚀 + +- Expanded and restructured documentation regarding Docker usage [#3312](https://github.com/MaibornWolff/codecharta/pull/3312)
+ ## [1.117.0] - 2023-05-19 ### Added 🚀 From 0ea12ce0c713f04d5e90578272289cf5da993b3c Mon Sep 17 00:00:00 2001 From: moritz-suckow Date: Thu, 25 May 2023 12:28:48 +0200 Subject: [PATCH 4/9] Integrate review feedback #3306 --- analysis/README.md | 6 +++--- visualization/README.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/analysis/README.md b/analysis/README.md index f0a87a9de0..f21e7c6a87 100644 --- a/analysis/README.md +++ b/analysis/README.md @@ -59,7 +59,7 @@ You can start with **Codecharta Analysis** on multiple ways: - Installation as a [npm package](#installation-via-npm) (Recommended) - Use our [Docker Image](#installation-via-docker) to run the analysis in a container -- Use [docker-compose]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}) to run this with all other containers +- Use [docker-compose]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}) to run the analysis in a complete environment with other needed tools like Sonar and a running CodeCharta Visualization instance to view your city map. - Download the SourceCode and [build it yourself](#manual-installation) ## Installation via npm @@ -78,8 +78,8 @@ We assume that you already installed docker, if not, you have to do that before! To containerize the analysis, please follow the below listed steps. - Navigate into the directory you want to analyse with CodeCharta. There are multiple ways to use the docker image: - 1. Start the docker container and a bash shell in it with `docker run -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis bash` (for that to work you have to make sure bash is added to your PATH). This runs the image and mounts the current directory and sets it as the working directory in the image. You can now use the CodeCharta shell or any other of the installed tools via the command line. - 2. Start the docker container and directly use some command (like the ccsh): `docker run -it -v $(pwd):$(pwd) -w $(pwd) codecharta-analysis ccsh`. This starts the Ccsh without any commands, which will open the parser suggestions. + 1. Start the docker container and a bash shell in it with `docker run -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis bash`. This runs the image and mounts the current directory and sets it as the working directory in the image. You can now use the CodeCharta shell or any other of the tools installed in the container via the command line. An overview with all tools installed can be found [here]({{site.baseurl}}{% link _docs/01-04-docker-containers.md#codecharta-analysis %}) + 2. Start the docker container and directly use some command (like the ccsh): `docker run -it -v $(pwd):$(pwd) -w $(pwd) codecharta-analysis ccsh`. This starts the Ccsh without any commands, which will open an interactive codecharta shell that will guide you through the parsing/analyzing process. 3. Start the docker container and directly use a specific parser: `docker run -it -v $(pwd):$(pwd) -w $(pwd) codecharta-analysis ccsh rawtextparser .`. This starts the RawTextParser in the current working directory in a container. - After analysing, you can copy any results with `docker cp codecharta-analysis:/root/fileName.cc.json fileName.cc.json` to your current working directory (replace `/root/` with correct path if file is not in root in container) diff --git a/visualization/README.md b/visualization/README.md index f591bad9ec..99296f449e 100755 --- a/visualization/README.md +++ b/visualization/README.md @@ -19,7 +19,7 @@ You can start with **Codecharta Visualization** on multiple ways: - Installation as a [npm package](#npm-package) (Recommended) - Run an operating system specific [standalone](#run-a-standalone) - Build it yourself from the github [repository](#build-it-yourself) -- Use [docker-compose]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}) to run this with all other containers +- Use [docker-compose]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}) to run this with other needed tools like a Sonar instance or analyzing tools of codecharta-analysis. - Use our [Dockerfile](#run-in-docker-container) to run the visualization in a container - Try out the [online version](https://maibornwolff.github.io/codecharta/visualization/app/index.html?file=codecharta.cc.json&file=codecharta_analysis.cc.json) @@ -149,8 +149,8 @@ We assume that you already installed docker, if not, you have to do that before! To containerize the visualization, please follow the below listed steps. -- Start the docker container: `docker run -d -p 80:9000 codecharta/codecharta-visualization`. This detaches the container and exposes port 80 on the container and port 9000 on the host. -- Open `localhost:9000` in your browser and you can already use the visualization! +- Start the docker container: `docker run -d -p 9000:80 codecharta/codecharta-visualization`. This detaches the container and exposes port 80 on the container and port 9000 on the host. +- Open `localhost:9000` in your browser and you can already use the visualization, upload `cc.json` files and play around! # JSON structure From aa66bbb69aac231d89e3b29094e0689b42b752df Mon Sep 17 00:00:00 2001 From: moritz-suckow Date: Thu, 25 May 2023 16:17:45 +0200 Subject: [PATCH 5/9] Fix various faults in docker examples #3306 --- analysis/README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/analysis/README.md b/analysis/README.md index f21e7c6a87..3d82973bbf 100644 --- a/analysis/README.md +++ b/analysis/README.md @@ -72,16 +72,17 @@ To run it you can call `ccsh` ## Installation via Docker -You can use this via docker compose or as a standalone container. This section will deal with how to use the analysis as a standalone container. For information on how to use this with docker compose, please check out [Docker Getting Started]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}) +You can use Codecharta analysis in multiple ways. This section will deal with how to use the analysis as a standalone container. For information on how to use with docker compose, please check out our [docker compose documentation]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}). We assume that you already installed docker, if not, you have to do that before! To containerize the analysis, please follow the below listed steps. - Navigate into the directory you want to analyse with CodeCharta. There are multiple ways to use the docker image: - 1. Start the docker container and a bash shell in it with `docker run -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis bash`. This runs the image and mounts the current directory and sets it as the working directory in the image. You can now use the CodeCharta shell or any other of the tools installed in the container via the command line. An overview with all tools installed can be found [here]({{site.baseurl}}{% link _docs/01-04-docker-containers.md#codecharta-analysis %}) - 2. Start the docker container and directly use some command (like the ccsh): `docker run -it -v $(pwd):$(pwd) -w $(pwd) codecharta-analysis ccsh`. This starts the Ccsh without any commands, which will open an interactive codecharta shell that will guide you through the parsing/analyzing process. - 3. Start the docker container and directly use a specific parser: `docker run -it -v $(pwd):$(pwd) -w $(pwd) codecharta-analysis ccsh rawtextparser .`. This starts the RawTextParser in the current working directory in a container. -- After analysing, you can copy any results with `docker cp codecharta-analysis:/root/fileName.cc.json fileName.cc.json` to your current working directory (replace `/root/` with correct path if file is not in root in container) + 1. Start the docker container and a bash shell in it with `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis bash`. This runs the image, names it `codecharta-analysis` and mounts the current directory and sets it as the working directory in the image. You can now use the codecharta shell or any other of the tools installed in the container via the command line. + 2. Start the docker container and directly use some command (like the ccsh): `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis ccsh`. This starts the Ccsh without any commands, which will open an interactive codecharta shell that will guide you through the parsing/analyzing process. Your current directory will be your previous working directory. + 3. Start the docker container and directly use a specific parser: `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis ccsh rawtextparser .`. This starts the RawTextParser in the current working directory in a container. +- After executing the run command once, you can repeat the same docker configuration with `docker start codecharta-analysis` or you have to change the name or delete the old container if you want to `docker run` a different configuration. +- After analysing, you can copy any results with `docker cp codecharta-analysis:/your/path/fileName.cc.json fileName.cc.json` to your current working directory (replace `/your/path/` with correct path in container). If this does not work, make sure you assigned the name `codecharta-analysis` to your container, if not use the correct name or container id. ## Manual Installation From fdeadf4a4f0aba7b09bc184b9ab59bf8e3a99b00 Mon Sep 17 00:00:00 2001 From: moritz-suckow Date: Thu, 25 May 2023 16:30:17 +0200 Subject: [PATCH 6/9] Fix broken links #3306 --- analysis/README.md | 4 ++-- visualization/README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/analysis/README.md b/analysis/README.md index 3d82973bbf..8d24ce3810 100644 --- a/analysis/README.md +++ b/analysis/README.md @@ -59,7 +59,7 @@ You can start with **Codecharta Analysis** on multiple ways: - Installation as a [npm package](#installation-via-npm) (Recommended) - Use our [Docker Image](#installation-via-docker) to run the analysis in a container -- Use [docker-compose]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}) to run the analysis in a complete environment with other needed tools like Sonar and a running CodeCharta Visualization instance to view your city map. +- Use [docker-compose](https://maibornwolff.github.io/codecharta/docs/docker-containers/) to run the analysis in a complete environment with other needed tools like Sonar and a running CodeCharta Visualization instance to view your city map. - Download the SourceCode and [build it yourself](#manual-installation) ## Installation via npm @@ -72,7 +72,7 @@ To run it you can call `ccsh` ## Installation via Docker -You can use Codecharta analysis in multiple ways. This section will deal with how to use the analysis as a standalone container. For information on how to use with docker compose, please check out our [docker compose documentation]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}). +You can use Codecharta analysis in multiple ways. This section will deal with how to use the analysis as a standalone container. For information on how to use with docker compose, please check out our [docker compose documentation](https://maibornwolff.github.io/codecharta/docs/docker-containers/). We assume that you already installed docker, if not, you have to do that before! To containerize the analysis, please follow the below listed steps. diff --git a/visualization/README.md b/visualization/README.md index 99296f449e..d5f52c48df 100755 --- a/visualization/README.md +++ b/visualization/README.md @@ -19,7 +19,7 @@ You can start with **Codecharta Visualization** on multiple ways: - Installation as a [npm package](#npm-package) (Recommended) - Run an operating system specific [standalone](#run-a-standalone) - Build it yourself from the github [repository](#build-it-yourself) -- Use [docker-compose]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}) to run this with other needed tools like a Sonar instance or analyzing tools of codecharta-analysis. +- Use [docker-compose](https://maibornwolff.github.io/codecharta/docs/docker-containers/) to run this with other needed tools like a Sonar instance or analyzing tools of codecharta-analysis. - Use our [Dockerfile](#run-in-docker-container) to run the visualization in a container - Try out the [online version](https://maibornwolff.github.io/codecharta/visualization/app/index.html?file=codecharta.cc.json&file=codecharta_analysis.cc.json) @@ -144,7 +144,7 @@ $ npm run e2e:auto ## Run in Docker container -You can use this via docker compose or as a standalone container. This section will deal with how to use the visualization as a standalone container. For information on how to use this with docker compose, please check out [Docker Getting Started]({{site.baseurl}}{% link _docs/01-04-docker-containers.md %}) +You can use this via docker compose or as a standalone container. This section will deal with how to use the visualization as a standalone container. For information on how to use this with docker compose, please check out [Docker Getting Started](https://maibornwolff.github.io/codecharta/docs/docker-containers/) We assume that you already installed docker, if not, you have to do that before! To containerize the visualization, please follow the below listed steps. From bb6bf46a9d52dee3be583c9ccb35647a230f0063 Mon Sep 17 00:00:00 2001 From: moritz-suckow Date: Thu, 25 May 2023 16:50:07 +0200 Subject: [PATCH 7/9] Fix broken sonar quality badge in visualization #3306 --- visualization/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/visualization/README.md b/visualization/README.md index d5f52c48df..640664db2a 100755 --- a/visualization/README.md +++ b/visualization/README.md @@ -1,6 +1,6 @@ # CodeCharta Visualization -[![Build Status](https://travis-ci.org/MaibornWolff/codecharta.svg?branch=main)](https://travis-ci.org/MaibornWolff/codecharta) +[![Quality Gate Status For Visualization](https://sonarcloud.io/api/project_badges/measure?project=maibornwolff-gmbh_codecharta_visualization&metric=alert_status)](https://sonarcloud.io/project/overview?id=maibornwolff-gmbh_codecharta_visualization) > CodeCharta by [MaibornWolff](https://www.maibornwolff.de) From bd747c5716c9648b577cfa586a1583ed5e9a71df Mon Sep 17 00:00:00 2001 From: moritz-suckow Date: Fri, 26 May 2023 09:16:25 +0200 Subject: [PATCH 8/9] Integrate second review changes #3306 --- CHANGELOG.md | 6 +++--- analysis/README.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c418925d35..b439747355 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,15 +9,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/) ### Added 🚀 -- Expanded and restructured documentation regarding Docker usage [#3312](https://github.com/MaibornWolff/codecharta/pull/3312)
+- Expand and restructure documentation regarding Docker usage [#3312](https://github.com/MaibornWolff/codecharta/pull/3312)
## [1.117.0] - 2023-05-19 ### Added 🚀 -- Added support for parser suggestions to SVN-, MetricGardener-, RawText- and SourceCodeParser [#3287](https://github.com/MaibornWolff/codecharta/pull/3287)
+- Add support for parser suggestions to SVN-, MetricGardener-, RawText- and SourceCodeParser [#3287](https://github.com/MaibornWolff/codecharta/pull/3287)
- Add semi automatic merging feature after executing multiple parsers [#3287](https://github.com/MaibornWolff/codecharta/pull/3287) -- Expanded developer documentation to include common problems and solutions for them [#3289](https://github.com/MaibornWolff/codecharta/pull/3289) +- Expand developer documentation to include common problems and solutions for them [#3289](https://github.com/MaibornWolff/codecharta/pull/3289) ### Fixed 🐞 diff --git a/analysis/README.md b/analysis/README.md index 8d24ce3810..fb7931eb05 100644 --- a/analysis/README.md +++ b/analysis/README.md @@ -78,8 +78,8 @@ We assume that you already installed docker, if not, you have to do that before! To containerize the analysis, please follow the below listed steps. - Navigate into the directory you want to analyse with CodeCharta. There are multiple ways to use the docker image: - 1. Start the docker container and a bash shell in it with `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis bash`. This runs the image, names it `codecharta-analysis` and mounts the current directory and sets it as the working directory in the image. You can now use the codecharta shell or any other of the tools installed in the container via the command line. - 2. Start the docker container and directly use some command (like the ccsh): `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis ccsh`. This starts the Ccsh without any commands, which will open an interactive codecharta shell that will guide you through the parsing/analyzing process. Your current directory will be your previous working directory. + 1. Start the docker container and a bash shell in it with `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis bash`. This runs the image, names the container `codecharta-analysis`, mounts the current directory and sets it as the working directory of your container. You can now use the codecharta shell or any other of the tools installed in the container via the command line. + 2. Start the docker container and directly use some command (like the ccsh): `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis ccsh`. This starts the Ccsh without any commands, which will open an interactive codecharta shell that will guide you through the parsing/analyzing process. The working directory of your Terminal will be used as the working directory of the container. 3. Start the docker container and directly use a specific parser: `docker run --name codecharta-analysis -it -v $(pwd):$(pwd) -w $(pwd) codecharta/codecharta-analysis ccsh rawtextparser .`. This starts the RawTextParser in the current working directory in a container. - After executing the run command once, you can repeat the same docker configuration with `docker start codecharta-analysis` or you have to change the name or delete the old container if you want to `docker run` a different configuration. - After analysing, you can copy any results with `docker cp codecharta-analysis:/your/path/fileName.cc.json fileName.cc.json` to your current working directory (replace `/your/path/` with correct path in container). If this does not work, make sure you assigned the name `codecharta-analysis` to your container, if not use the correct name or container id. From 8b72fa700672bd8f5e34b94b84fe36cf46354f3a Mon Sep 17 00:00:00 2001 From: moritz-suckow Date: Fri, 2 Jun 2023 10:01:53 +0200 Subject: [PATCH 9/9] Remove unneeded breaks from changelog #3306 --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f0ba0c1a97..2f9206ec55 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,13 +11,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/) - Add metric tooltips that display attribute descriptors and provide hyperlinks in the sidebar to the metric's documentation [#3273](https://github.com/MaibornWolff/codecharta/pull/3273)
-- Expand and restructure documentation regarding Docker usage [#3312](https://github.com/MaibornWolff/codecharta/pull/3312)
+- Expand and restructure documentation regarding Docker usage [#3312](https://github.com/MaibornWolff/codecharta/pull/3312) ## [1.117.0] - 2023-05-19 ### Added 🚀 -- Add support for parser suggestions to SVN-, MetricGardener-, RawText- and SourceCodeParser [#3287](https://github.com/MaibornWolff/codecharta/pull/3287)
+- Add support for parser suggestions to SVN-, MetricGardener-, RawText- and SourceCodeParser [#3287](https://github.com/MaibornWolff/codecharta/pull/3287) - Add semi automatic merging feature after executing multiple parsers [#3287](https://github.com/MaibornWolff/codecharta/pull/3287) - Expand developer documentation to include common problems and solutions for them [#3289](https://github.com/MaibornWolff/codecharta/pull/3289)