Skip to content

Commit 42ef1ec

Browse files
committed
Automated environment variables documentation generation (CI)
1 parent 8677a6f commit 42ef1ec

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

scripts/ENVIRONMENT_VARIABLES.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ ARTIFACTS_DIRECTORY | artifacts | Wo
1919
SOURCE_DIRECTORY | source | |
2020
LOG_GROUP_START | ::group:: | Prefix to start a log group. Defaults to GitHub Actions log group start command. |
2121
LOG_GROUP_END | ::endgroup:: | Prefix to end a log group. Defaults to GitHub Actions log group end command. |
22+
NEO4J_EDITION | community | Choose "community" or "enterprise" |
23+
NEO4J_VERSION | 2026.01.4 | |
24+
DATA_DIRECTORY | $( pwd -P )/data | Path where Neo4j writes its data to (outside tools dir) |
25+
RUNTIME_DIRECTORY | $( pwd -P )/runtime | Path where Neo4j puts runtime data to (e.g. logs) (outside tools dir) |
26+
NEO4J_HTTP_PORT | 7474 | Neo4j HTTP API port for executing queries |
27+
NEO4J_HTTPS_PORT | 7473 | Neo4j HTTPS port for encrypted querying |
28+
NEO4J_BOLT_PORT | 7687 | Neo4j's own "Bolt Protocol" port |
29+
NEO4J_CONFIG_TEMPLATE | template-neo4j.conf | Name of the template file ("configuration" folder) for the Neo4j configuration. Defaults to "template-neo4j.conf". |
2230
ARTIFACTS_CHANGE_DETECTION_HASH_FILE | artifactsChangeDetectionHash.txt | !DEPRECATED! Use CHANGE_DETECTION_HASH_FILE. |
2331
CHANGE_DETECTION_HASH_FILE_PATH | ./${ARTIFACTS_DIRECTORY}/${CHANGE_DETECTION_HASH_FILE} | Default path of the file that contains the hash code of the file list for change detection. Can be overridden by a command line option. |
2432
ENABLE_JUPYTER_NOTEBOOK_PDF_GENERATION | | Enable PDF generation for Jupyter Notebooks if set to any non empty value like "true" or disable it with "" or "false". |
@@ -27,12 +35,9 @@ REPORTS_DIRECTORY | reports | |
2735
REPORTS_SCRIPT_DIR | ${SCRIPTS_DIR}/reports | Repository directory containing the report scripts |
2836
CYPHER_DIR | ${SCRIPTS_DIR}/../cypher | |
2937
MARKDOWN_SCRIPTS_DIR | ${SCRIPTS_DIR}/markdown | |
30-
NEO4J_HTTP_PORT | 7474 | Neo4j HTTP API port for executing queries |
3138
NEO4J_HTTP_TRANSACTION_ENDPOINT | db/neo4j/tx/commit | Since Neo4j v5: "db/<name>/tx/commit", Neo4j v4: "db/data/transaction/commit" |
3239
IMPORT_DIRECTORY | import | |
3340
IMPORT_GIT_LOG_DATA_IF_SOURCE_IS_PRESENT | plugin | Select how to import git log data. Options: "none", "aggregated", "full" and "plugin". Default="plugin". |
34-
NEO4J_VERSION | 2026.01.4 | Neo4j Graph Database Version. Current versions: >= 2025.03.0. Version 4.4.42 and 5.26.5 are the previous LTS (long term support) versions as of April 2025. |
35-
NEO4J_CONFIG_TEMPLATE | template-neo4j.conf | |
3641
NEO4J_APOC_PLUGIN_VERSION | 2026.01.4 | |
3742
NEO4J_APOC_PLUGIN_EDITION | core | |
3843
NEO4J_APOC_PLUGIN_GITHUB | neo4j/apoc | |
@@ -50,9 +55,4 @@ TOOLS_DIRECTORY | tools | Ge
5055
TYPESCRIPT_SCAN_HEAP_MEMORY | 4096 | Heap memory in megabytes for Typescript scanning with (Node.js process). Defaults to 4096 MB. |
5156
JQASSISTANT_CLI_DOWNLOAD_URL | https://repo1.maven.org/maven2/com/buschmais/jqassistant/cli | Download URL for the jQAssistant CLI |
5257
JQASSISTANT_CLI_DISTRIBUTION | distribution.zip | Neo4j v5 & v4: "distribution.zip" |
53-
NEO4J_EDITION | community | Choose "community" or "enterprise" |
54-
DATA_DIRECTORY | $( pwd -P )/data | Path where Neo4j writes its data to (outside tools dir) |
55-
RUNTIME_DIRECTORY | $( pwd -P )/runtime | Path where Neo4j puts runtime data to (e.g. logs) (outside tools dir) |
56-
NEO4J_HTTPS_PORT | 7473 | Neo4j HTTPS port for encrypted querying |
57-
NEO4J_BOLT_PORT | 7687 | Neo4j's own "Bolt Protocol" port |
5858
IGNORED_JARS_DIRECTORY | ./../ignored-jars | Directory to move the filtered out .jar files to |

0 commit comments

Comments
 (0)