Skip to content

Commit 8ef225d

Browse files
committed
Document how to run a local analysis
1 parent 049f591 commit 8ef225d

File tree

2 files changed

+19
-9
lines changed

2 files changed

+19
-9
lines changed

COMMANDS.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,27 @@
44

55
Use the following commands in the root directory of this repository to start an analysis manually e.g. for [AxonFramework](./scripts/artifacts/downloadAxonFramework.sh).
66

7-
### Notes
8-
9-
- Be sure to use Java 11 (June 2023 Neo4j 4.x requirement)
10-
- Use your own initial Neo4j password
11-
- It uses the script [analyze.sh](./scripts/analysis/analyze.sh)
12-
- The script file names (without the prefix "download" and without the file extension) in the directory [scripts/artifacts](./scripts/artifacts) provide the possible analysis names.
13-
14-
157
```shell
168
export NEO4J_INITIAL_PASSWORD=theinitialpasswordthatihavechosenforneo4j
179
mkdir -p ./temp
18-
./../scripts/analysis/analyze.sh --name AxonFramework --version 4.7.5 --report All
10+
cd temp
11+
./../scripts/analysis/analyze.sh --name AxonFramework --version 4.8.0
1912
```
2013

14+
Add the command line argument `--report Csv` to only run the CSV reports when you don't have Python set up
15+
or want to skip Jupyter Notebooks.
16+
17+
Add the command line argument `--profile Neo4jv4` if you want to use the older long term support (june 2023)
18+
version v4.4.x of Neo4j and compatible versions of plugins and JQAssistant.
19+
20+
### Notes
21+
22+
- Be sure to use Java 11 (Mai 2023 Neo4j v4 requirement) or Java 17 (June 2023 Neo4j v5 and jQAssistant CLI v2)
23+
- Use your own initial Neo4j password
24+
- For more details have a look at the script [analyze.sh](./scripts/analysis/analyze.sh)
25+
- The script file names (without the prefix "download" and without the file extension) in the directory [scripts/artifacts](./scripts/artifacts) provide all analysis names that are available.
26+
27+
2128
Have a look at [code-reports.yml](./.github/workflows/code-reports.yml) for all details about setup steps and full automation.
2229

2330
## Generate Markdown References

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ The [Code Reports Pipeline](./.github/workflows/code-reports.yml) utilizes [GitH
7575

7676
## 🤔 Questions & Answers
7777

78+
- How can i run an analysis locally?
79+
👉 See [start-an-analysis](./COMMANDS.md#start-an-analysis) in the [Commands Reference](./COMMANDS.md).
80+
7881
- How can i add an CSV report to the pipeline?
7982
👉 Put your new cypher query into the [cypher](./cypher) directory or a suitable (new) sub directory.
8083
👉 Create a new CSV report script in the [scripts/reports](./scripts/reports/) directory. Take for example [OverviewCsv.sh](./scripts/reports/OverviewCsv.sh) as a reference.

0 commit comments

Comments
 (0)