Document public reuseable workflow

Author: JohT

.github/workflows/internal-check-links-in-documentation.yml

@@ -9,6 +9,7 @@ on:
       - 'README.md'
       - 'COMMANDS.md'
       - 'GETTING_STARTED.md'
+      - 'INTEGRATION.md'
       - '.github/workflows/check-links-in-documentation.yml' # also run when this file was changed
   schedule:
     - cron: "15 6 1 * *" # On the first day of each month at 6:15 o'clock
@@ -36,6 +37,6 @@ jobs:
 
     - name: Check links in top level documentation Markdown files
       if: ${{ ! env.skip_link_check}}
-      run: npx --yes [email protected] --verbose --alive=200,202,206 --retry README.md COMMANDS.md GETTING_STARTED.md
+      run: npx --yes [email protected] --verbose --alive=200,202,206 --retry README.md COMMANDS.md GETTING_STARTED.md INTEGRATION.md
       # Temporarily, everything is done using command line options rather than with the config file, which doesn't seem to work.
       # Maybe related to https://github.com/tcort/markdown-link-check/issues/379 ?

COMMANDS.md

@@ -193,7 +193,7 @@ Change into the [scripts](./scripts/) directory e.g. with `cd scripts` and then
 The following command shows how to use [markdown-link-check](https://github.com/tcort/markdown-link-check) to for example check the links in the [README.md](./README.md) file:
 
 ```script
-npx --yes markdown-link-check --quiet --progress --config=markdown-lint-check-config.json README.md COMMANDS.md GETTING_STARTED.md
+npx --yes markdown-link-check --quiet --progress --config=markdown-lint-check-config.json README.md COMMANDS.md GETTING_STARTED.md INTEGRATION.md
 ```
 
 ## Manual Setup

INTEGRATION.md

@@ -0,0 +1,11 @@
+# Code Graph Analysis Pipeline - Integration guide
+
+This document describes the steps to get started as quickly as possible.  
+👉 For more details on what else you can do see [README](./README.md).  
+👉 For more details on how to analyze your code locally see [GETTING_STARTED](./GETTING_STARTED.md).  
+
+## 🛠 Setup
+
+This repository provides a public reuseable GitHub Actions Workflow that can be used to analyze code repositories. The workflow is defined in the file [./.github/workflows/public-analyze-code-graph.yml](./.github/workflows/public-analyze-code-graph.yml). You can trigger this workflow in your pipeline. A fully working example can be found in [./.github/workflows/internal-java-code-analysis.yml](./.github/workflows/internal-java-code-analysis.yml) and [./.github/workflows/internal-typescript-code-analysis.yml](./.github/workflows/internal-typescript-code-analysis.yml).
+
+Note: Workflows with names starting with `internal-` are private and should not be used outside of this repository. They might change anytime without notice.

README.md

@@ -14,6 +14,7 @@ Contained within this repository is a comprehensive and automated code graph ana
 - Fully automated [pipeline for Java](./.github/workflows/java-code-analysis.yml) from tool installation to report generation
 - Fully automated [pipeline for Typescript](./.github/workflows/typescript-code-analysis.yml) from tool installation to report generation
 - Fully automated [local run](./GETTING_STARTED.md)
+- Easy integratable in your [continuous integration pipeline](./INTEGRATION.md)
 - More than 130 CSV reports for dependencies, metrics, cycles, annotations, algorithms and many more
 - Jupyter notebook reports for dependencies, metrics, visibility and many more
 - Graph structure visualization
@@ -105,6 +106,11 @@ This could be as simple as running the following command in your Typescript proj
 
 See [GETTING_STARTED.md](./GETTING_STARTED.md) on how to get started on your local machine.
 
+## :rocket: Integration
+
+See [INTEGRATION.md](./INTEGRATION.md) on how to integrate code analysis in your continuous integration pipeline.
+Currently (2025), only GitHub Actions are supported.
+
 ## :building_construction: Pipeline and Tools
 
 The [Code Structure Analysis Pipeline](./.github/workflows/java-code-analysis.yml) utilizes [GitHub Actions](https://docs.github.com/de/actions) to automate the whole analysis process: