[ops]: add warning for custom APPSMITH_GIT_ROOT

[pratapaprasanna]

No description provided.

[coderabbitai]

Walkthrough

Walkthrough

The recent update introduces a warning in the run-with-env.sh script, alerting users about the upcoming deprecation of custom configurations for the APPSMITH_GIT_ROOT environment variable. This change aims to streamline configurations and ensure users are prepared for future updates that might restrict custom settings.

Changes

File Path	Change Summary
.../appsmith/run-with-env.sh	Added a warning message about the deprecation of custom configurations for the APPSMITH_GIT_ROOT environment variable.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d4937d3 and f759439.

Files selected for processing (1)

• deploy/docker/fs/opt/appsmith/run-with-env.sh (1 hunks)

Additional Context Used

ShellCheck (2)

deploy/docker/fs/opt/appsmith/run-with-env.sh (2)

[warning] 7-7: ShellCheck can't follow non-constant source. Use a directive to specify location.

---

[warning] 8-8: ShellCheck can't follow non-constant source. Use a directive to specify location.

Additional comments not posted (1)

deploy/docker/fs/opt/appsmith/run-with-env.sh (1)

Line range hint 7-8: Consider specifying the location of the sourced files to enhance script reliability.

Verification successful

---

The review comment about verifying the existence and readability of the environment configuration files is valid. However, the initial test script failed to find these files due to environmental setup issues, not because the files or paths are incorrectly handled in the codebase. The variables ENV_PATH and PRE_DEFINED_ENV_PATH are consistently set across multiple scripts to specific paths:

• ENV_PATH is set to "/appsmith-stacks/configuration/docker.env"
• PRE_DEFINED_ENV_PATH is set to "$TMP/pre-define.env"

These paths are hardcoded and used in various scripts, indicating a structured approach to environment management in the codebase.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify the existence and readability of environment configuration files.

# Test: Check if the environment configuration files exist and are readable.
if [[ -f "$ENV_PATH" ]] && [[ -r "$ENV_PATH" ]]; then
  echo "$ENV_PATH exists and is readable."
else
  echo "$ENV_PATH does not exist or is not readable."
fi

if [[ -f "$PRE_DEFINED_ENV_PATH" ]] && [[ -r "$PRE_DEFINED_ENV_PATH" ]]; then
  echo "$PRE_DEFINED_ENV_PATH exists and is readable."
else
  echo "$PRE_DEFINED_ENV_PATH does not exist or is not readable."
fi

Length of output: 189

---

---

Script:

#!/bin/bash
# Description: Search for occurrences of `ENV_PATH` and `PRE_DEFINED_ENV_PATH` being set in the codebase.

# Search for the setting of `ENV_PATH`
echo "Occurrences of ENV_PATH being set:"
rg "ENV_PATH="

# Search for the setting of `PRE_DEFINED_ENV_PATH`
echo "Occurrences of PRE_DEFINED_ENV_PATH being set:"
rg "PRE_DEFINED_ENV_PATH="

Length of output: 695

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[pratapaprasanna]

/build-deploy-preview skip-tests=true

[github-actions]

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9031756843.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33355.
recreate: .

[coderabbitai]

Actionable comments posted: 0

Out of diff range and nitpick comments (1)

deploy/docker/fs/opt/appsmith/run-with-env.sh (1)

34-34: Ensure the deprecation warning for APPSMITH_GIT_ROOT is clear and actionable.

Consider adding more details about the deprecation timeline or alternative configurations to the warning message. This will help users understand the urgency and the necessary steps they should take.

[github-actions]

Deploy-Preview-URL: https://ce-33355.dp.appsmith.com

[github-actions]

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.