Skip to content

Commit 176cee5

Browse files
committed
fixup! Generate reference documentation for the whole project.
1 parent b58a20a commit 176cee5

7 files changed

Lines changed: 532 additions & 387 deletions

File tree

.github/workflows/internal-cypher-reference-documentation.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,8 @@ jobs:
2828
token: ${{ secrets.WORKFLOW_GIT_ACCESS_TOKEN }}
2929

3030
- name: Generate cypher reference document
31-
working-directory: cypher
3231
run: |
33-
./../scripts/documentation/generateCypherReference.sh
32+
./scripts/documentation/generateCypherReference.sh
3433
3534
- name: Use git to detect changes in the regenerated document and set generated_document_changed
3635
run: git diff --quiet || echo "generated_document_changed=true" >> $GITHUB_ENV
@@ -43,7 +42,7 @@ jobs:
4342
uses: actions/upload-artifact@v6
4443
with:
4544
name: cypher-reference-document
46-
path: ./cypher/CYPHER.md
45+
path: ./CYPHER.md
4746
if-no-files-found: error
4847
retention-days: 5
4948

@@ -57,13 +56,13 @@ jobs:
5756
git config --global user.email "7671054+JohT@users.noreply.github.com"
5857
git fetch origin
5958
git status
60-
git add ./cypher/CYPHER.md
59+
git add ./CYPHER.md
6160
git status
6261
git commit -m "${{ env.CI_COMMIT_MESSAGE }}"
6362
git status
6463
git rebase --strategy-option=theirs origin/main --verbose
6564
git status
66-
git add ./cypher/CYPHER.md
65+
git add ./CYPHER.md
6766
git status
6867
git commit --amend --no-edit
6968
git status

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,7 @@ For all details see: https://github.com/JohT/code-graph-analysis-pipeline/releas
528528
* Analyze static code structure, dependencies, metrics, ...
529529
* Fully automated [pipeline](./.github/workflows/public-analyze-code-graph.yml) from tool installation and artifact download to report generation
530530
* Runtime and library independent automation using [shell scripts](./SCRIPTS.md)
531-
* Comprehensive list of [Cypher queries](./cypher/CYPHER.md)
531+
* Comprehensive list of [Cypher queries](./CYPHER.md)
532532
* Example Analysis for [AxonFramework](https://github.com/AxonFramework/AxonFramework)
533533

534534
### 📖 Jupyter Notebook Reports

COMMANDS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,10 +168,10 @@ To further narrow down to only one report type within a specific domain:
168168

169169
### Generate Cypher Reference
170170

171-
Change into the [cypher](./cypher/) directory e.g. with `cd cypher` and then execute the script [generateCypherReference.sh](./scripts/documentation/generateCypherReference.sh) with the following command:
171+
Execute the script [generateCypherReference.sh](./scripts/documentation/generateCypherReference.sh) from the root directory with the following command:
172172

173173
```script
174-
./../scripts/documentation/generateCypherReference.sh
174+
./scripts/documentation/generateCypherReference.sh
175175
```
176176

177177
### Generate Script Reference

CYPHER.md

Lines changed: 511 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Curious? Explore the examples at [code-graph-analysis-examples](https://github.c
2828
- Automated reference document generation
2929
- Runtime and library independent automation using [shell scripts](./SCRIPTS.md)
3030
- Tested on MacOS (zsh), Linux (bash) and Windows (Git Bash)
31-
- Comprehensive list of [Cypher queries](./cypher/CYPHER.md)
31+
- Comprehensive list of [Cypher queries](./CYPHER.md)
3232
- Example analysis for [AxonFramework](https://github.com/AxonFramework/AxonFramework)
3333
- Example analysis for [react-router](https://github.com/remix-run/react-router)
3434

@@ -198,7 +198,7 @@ The [Code Structure Analysis Pipeline](./.github/workflows/internal-java-code-an
198198

199199
## :mag: Cypher Query Reference
200200

201-
[CYPHER.md](./cypher/CYPHER.md) lists all Cypher queries of this repository including their first comment line as a description. It can be generated as described in [Generate Cypher Reference](./COMMANDS.md#generate-cypher-reference).
201+
[CYPHER.md](./CYPHER.md) lists all Cypher queries of this repository including their first comment line as a description. It can be generated as described in [Generate Cypher Reference](./COMMANDS.md#generate-cypher-reference).
202202
> [Cypher](https://neo4j.com/docs/getting-started/cypher-intro) is Neo4j’s graph query language that lets you retrieve data from the graph.
203203
204204
## :globe_with_meridians: Environment Variable Reference

0 commit comments

Comments
 (0)