[Docs] Update ENV.md to Include All Environment Variables #1526
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the ENV.md file after analysing process.env Signed-off-by: Satwik Sai Prakash Sahoo <57804606+satwiksps@users.noreply.github.com>
prabhu
reviewed
Jan 2, 2025
docs/ENV.md
Outdated
| | 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. | | ||
| | OPENAI_API_KEY | API key for OpenAI integration. Used for authenticating requests to OpenAI services when performing operations like AI-driven text or code generation. | |
There was a problem hiding this comment.
There is no openai integration. Please remove this.
There was a problem hiding this comment.
I am little confused. From the reviews I conclude that you want me to remove all the additional documentation in this PR and add Add JAVA21, JAVA22, and JAVA23. Do you want me to do the same ? Should I create another PR in accordance to your reviews ?
There was a problem hiding this comment.
OPENAI_API_KEY. Only specific variables have to removed according to the comment.
prabhu
reviewed
Jan 2, 2025
docs/ENV.md
Outdated
| | 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. | | ||
| | CI | Indicates whether the current environment is a Continuous Integration (CI) environment. Used to modify behavior during CI pipelines (e.g., skipping non-essential tasks or banners). | |
prabhu
reviewed
Jan 2, 2025
docs/ENV.md
Outdated
| | GRADLE_ARGS | A space-separated list of additional arguments passed to Gradle commands. Useful for providing custom profiles, configurations, or settings for builds. | | ||
| | CI | Indicates whether the current environment is a Continuous Integration (CI) environment. Used to modify behavior during CI pipelines (e.g., skipping non-essential tasks or banners). | | ||
| | GITHUB_REPOSITORY | Provides the name of the GitHub repository in the `owner/repo` format. Useful for identifying the repository context in GitHub workflows or other automated tasks. | |
There was a problem hiding this comment.
Remove CI and GITHUB_REPOSITORY.
prabhu
reviewed
Jan 2, 2025
docs/ENV.md
Outdated
| | CI | Indicates whether the current environment is a Continuous Integration (CI) environment. Used to modify behavior during CI pipelines (e.g., skipping non-essential tasks or banners). | | ||
| | GITHUB_REPOSITORY | Provides the name of the GitHub repository in the `owner/repo` format. Useful for identifying the repository context in GitHub workflows or other automated tasks. | | ||
| | ATOM_SLICE_DEPTH | Specifies the depth for Atom slice analysis during data-flow operations. Increasing this value can provide deeper insights but may increase processing time. | |
There was a problem hiding this comment.
Let's remove ATOM_SLICE_DEPTH.
prabhu
reviewed
Jan 2, 2025
docs/ENV.md
Outdated
| | 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. | | ||
| | ATOM_DB | Path to the Atom slices database. Can be customized to specify a different location for database storage used during atom-based analysis. | |
prabhu
reviewed
Jan 2, 2025
| | 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. | | ||
| | 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. | |
There was a problem hiding this comment.
Add JAVA21, JAVA22, and JAVA23
Removed documentation for OPENAI_API_KEY, CI, GITHUB_REPOSITORY, ATOM_SLICE_DEPTH, ATOM_DB. Added documentation for JAVA21, JAVA22, and JAVA23. Signed-off-by: Satwik Sai Prakash Sahoo <57804606+satwiksps@users.noreply.github.com>
prabhu
approved these changes
Jan 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request: [Docs] Update ENV.md with All Environment Variables (#1494)
Summary
This pull request updates the
ENV.mdfile to include all relevant environment variables, ensuring comprehensive documentation for configuration and usage. The changes align with the project's goal of maintaining clarity and completeness in documentation.Changes Made
Added:
ENV.md, such as:GLOBAL_AGENT_ENVIRONMENT_VARIABLE_NAMESPACEJAVA8_TOOL,JAVA11_TOOL,JAVA17_TOOLCDXGEN_PLUGINS_DIRASTGEN_IGNORE_DIRSPIP_INSTALL_ARGS,PIP_TARGET, and more.Ignored:
Purpose of the Update
Checklist
Additional Notes