Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Update ENV.md to Include All Environment Variables #1526

Merged
merged 2 commits into from
Jan 2, 2025
Merged

[Docs] Update ENV.md to Include All Environment Variables #1526

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0593281
Update ENV.md
satwiksps Jan 2, 2025
6271447
Update ENV.md
satwiksps Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion docs/ENV.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,23 @@ The following environment variables are available to configure the bom generatio
| SWIFT_COMPILER_ARGS | Full compiler arguments string to use for semantic analysis. Eg: -sdk <path> -F <path> -Xcc -I <path> |
| SWIFT_SDK_ARGS | Swift sdk arguments. Eg: -sdk <path> |
| SWIFT_COMPILER_EXTRA_ARGS | Extra compiler arguments to add to the auto-detected string. Eg: -suppress-warnings -track-system-dependencies |
| GO_FETCH_VCS | Set this variable to `true` or `1` to fetch vcs url from pkg.go.dev. For golang |
| GO_FETCH_VCS | Set this variable to `true` or `1` to fetch vcs url from pkg.go.dev. For golang |
| GLOBAL_AGENT_ENVIRONMENT_VARIABLE_NAMESPACE | Specifies the namespace for HTTP_PROXY variable usage. If not set by the user, it defaults to an empty string to support standard HTTP proxy configurations. |
| JAVA8_TOOL | Specifies the Java 8 toolchain version to use. Defaults to `8.0.432-tem` if not explicitly set. Can be overridden to point to a custom Java 8 version. |
| JAVA11_TOOL | Specifies the Java 11 toolchain version to use. Defaults to `11.0.25-tem` if not explicitly set. Can be overridden to point to a custom Java 11 version. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add JAVA21, JAVA22, and JAVA23

| JAVA17_TOOL | Specifies the Java 17 toolchain version to use. Defaults to `17.0.13-tem` if not explicitly set. Can be overridden to point to a custom Java 17 version. |
| JAVA21_TOOL | Specifies the Java 21 toolchain version to use. Defaults to `21.0.5-tem` if not explicitly set. Can be overridden to point to a custom Java 21 version. |
| JAVA22_TOOL | Specifies the Java 22 toolchain version to use. Defaults to `22.0.2-tem` if not explicitly set. Can be overridden to point to a custom Java 22 version. |
| JAVA23_TOOL | Specifies the Java 23 toolchain version to use. Defaults to `23.0.1-tem` if not explicitly set. Can be overridden to point to a custom Java 23 version. |
| CDXGEN_PLUGINS_DIR | Defines the directory where cdxgen plugins are stored. If not set, defaults to an empty value, and a global node_modules path is used if available. |
| GLOBAL_NODE_MODULES_PATH | Specifies the path to the global `node_modules` directory. Used when a local plugins directory is not provided. |
| ASTGEN_IGNORE_DIRS | Comma-separated list of directories to ignore during abstract syntax tree (AST) generation. Defaults to a predefined list such as `venv` to avoid unnecessary parsing of certain directories. |
| CDXGEN_IN_CONTAINER | Set to `true` to indicate that the process is running inside a containerized environment. Affects the configuration of certain container-specific settings and optimizations. |
| PIP_INSTALL_ARGS | Provides additional arguments for `pip install` commands, such as `--python-version`, `--ignore-requires-python`, and `--no-warn-conflicts`. Useful for custom Python dependency installations. |
| PIP_TARGET | Specifies the target directory for pip installations, often used when dependencies are installed into temporary or isolated directories. |
| NODE_NO_READLINE | Set to `1` to disable canonical terminal settings and enable custom readline behavior for Node.js REPL or command-line tools. |
| CDXGEN_REPL_HISTORY | Specifies the path to save REPL command history. If not set and the default directory does not exist, REPL history will not be saved. |
| GRADLE_USER_HOME | Specifies the directory for the Gradle user home, which typically contains cache files, build dependencies, and other configuration files used by Gradle. |
| GRADLE_ARGS | A space-separated list of additional arguments passed to Gradle commands. Useful for providing custom profiles, configurations, or settings for builds. |
| SDKMAN_VERSION | Specifies the version of SDKMAN to use. Useful for managing SDKs and ensuring compatibility with tools and environments. |
| NVM_DIR | Defines the directory where Node Version Manager (NVM) is installed. Used to locate and manage Node.js versions in environments where NVM is utilized. |
Loading