Skip to content

fix: added missing env variables in env demo and sample#1494

Merged
pranalidhanavade merged 1 commit intomainfrom
fix/add-variables-in-env-demo-and-sample
Oct 24, 2025
Merged

fix: added missing env variables in env demo and sample#1494
pranalidhanavade merged 1 commit intomainfrom
fix/add-variables-in-env-demo-and-sample

Conversation

@pranalidhanavade
Copy link
Copy Markdown
Contributor

@pranalidhanavade pranalidhanavade commented Oct 24, 2025

What

  • fix: added missing env variables in env demo and sample

Summary by CodeRabbit

  • Chores
    • Updated configuration templates with new ECS-related environment variables: cluster name, task definition family, protocol, AWS account ID, and S3 bucket ARN for enhanced container orchestration setup.

Signed-off-by: pranalidhanavade <pranali.dhanavade@ayanworks.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Oct 24, 2025

Walkthrough

New environment variables for ECS configuration have been added to .env.demo and .env.sample files, including CLUSTER_NAME, TASKDEFINITION_FAMILY, PROTOCOL, AWS_ACCOUNT_ID, and S3_BUCKET_ARN. These are configuration-only additions with no behavioral changes.

Changes

Cohort / File(s) Summary
Environment Configuration Files
.env.demo, .env.sample
Added new ECS-related environment variables (CLUSTER_NAME, TASKDEFINITION_FAMILY, PROTOCOL, AWS_ACCOUNT_ID, S3_BUCKET_ARN) with inline documentation; no logic modifications.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

  • KambleSahil3

Poem

🐰 The configuration grows,
New variables in a row,
ECS settings bloom and spread,
Environment configs fed,
Cluster names and buckets deep,
Where our cloud resources sleep! 🌩️✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "fix: added missing env variables in env demo and sample" directly and accurately reflects the main changes in the changeset. The title clearly identifies the type of change (adding missing environment variables) and specifies the files affected (.env.demo and .env.sample). The title is concise, uses conventional commit formatting with the "fix:" prefix, and avoids vague or generic language. It is specific enough that someone reviewing the commit history would immediately understand the primary change.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/add-variables-in-env-demo-and-sample

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sonarqubecloud
Copy link
Copy Markdown

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.env.sample (1)

106-107: Remove duplicate and misspelled environment variables.

Line 106 defines CLUSTER_NAME="" with an empty value, and line 107 defines TESKDEFINITION_FAMILY (misspelled—should be TASKDEFINITION_FAMILY). These are now being redefined correctly at lines 200–202. Remove the old definitions to avoid confusion and duplication.

-CLUSTER_NAME=""  # ecs cluster
-TESKDEFINITION_FAMILY="" # ecs task-definition
 AGENT_PROTOCOL=http
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a4d9755 and eda8bf8.

📒 Files selected for processing (2)
  • .env.demo (1 hunks)
  • .env.sample (1 hunks)
🧰 Additional context used
🪛 dotenv-linter (4.0.0)
.env.demo

[warning] 179-179: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)


[warning] 180-180: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)


[warning] 181-181: [UnorderedKey] The PROTOCOL key should go before the TASKDEFINITION_FAMILY key

(UnorderedKey)


[warning] 182-182: [UnorderedKey] The AWS_ACCOUNT_ID key should go before the CLUSTER_NAME key

(UnorderedKey)


[warning] 182-182: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)


[warning] 183-183: [UnorderedKey] The S3_BUCKET_ARN key should go before the TASKDEFINITION_FAMILY key

(UnorderedKey)


[warning] 183-183: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)

.env.sample

[warning] 200-200: [DuplicatedKey] The CLUSTER_NAME key is duplicated

(DuplicatedKey)


[warning] 200-200: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)


[warning] 201-201: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)


[warning] 202-202: [UnorderedKey] The PROTOCOL key should go before the TASKDEFINITION_FAMILY key

(UnorderedKey)

Comment thread .env.demo
Comment on lines +179 to +183
CLUSTER_NAME=CREDO-CONTROLLER-CLUSTER # ECS cluster name for credo controller
TASKDEFINITION_FAMILY=CREDO-CONTROLLER-TASKDEFINITION # ECS taskdefinition name for credo controller
PROTOCOL=http
AWS_ACCOUNT_ID=xxxxx // Please provide your AWS account Id
S3_BUCKET_ARN=arn:aws:s3:::xxxxx // Please provide your AWS bucket arn
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Quote environment variable values, standardize comment format, and fix key ordering.

The newly added variables lack quotes around their values—a violation of dotenv formatting standards. Additionally, the comment format is inconsistent: line 181 uses # while lines 182–183 use //. Standardize on # for shell/dotenv files. Static analysis also flags that keys should be ordered alphabetically (e.g., AWS_ACCOUNT_ID before CLUSTER_NAME, PROTOCOL before TASKDEFINITION_FAMILY, and S3_BUCKET_ARN early in the sequence).

-CLUSTER_NAME=CREDO-CONTROLLER-CLUSTER  # ECS cluster name for credo controller
-TASKDEFINITION_FAMILY=CREDO-CONTROLLER-TASKDEFINITION # ECS taskdefinition name for credo controller
-PROTOCOL=http
-AWS_ACCOUNT_ID=xxxxx  // Please provide your AWS account Id
-S3_BUCKET_ARN=arn:aws:s3:::xxxxx  // Please provide your AWS bucket arn
+AWS_ACCOUNT_ID="xxxxx"  # Please provide your AWS account Id
+CLUSTER_NAME="CREDO-CONTROLLER-CLUSTER"  # ECS cluster name for credo controller
+PROTOCOL=http
+S3_BUCKET_ARN="arn:aws:s3:::xxxxx"  # Please provide your AWS bucket arn
+TASKDEFINITION_FAMILY="CREDO-CONTROLLER-TASKDEFINITION" # ECS taskdefinition name for credo controller
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
CLUSTER_NAME=CREDO-CONTROLLER-CLUSTER # ECS cluster name for credo controller
TASKDEFINITION_FAMILY=CREDO-CONTROLLER-TASKDEFINITION # ECS taskdefinition name for credo controller
PROTOCOL=http
AWS_ACCOUNT_ID=xxxxx // Please provide your AWS account Id
S3_BUCKET_ARN=arn:aws:s3:::xxxxx // Please provide your AWS bucket arn
AWS_ACCOUNT_ID="xxxxx" # Please provide your AWS account Id
CLUSTER_NAME="CREDO-CONTROLLER-CLUSTER" # ECS cluster name for credo controller
PROTOCOL=http
S3_BUCKET_ARN="arn:aws:s3:::xxxxx" # Please provide your AWS bucket arn
TASKDEFINITION_FAMILY="CREDO-CONTROLLER-TASKDEFINITION" # ECS taskdefinition name for credo controller
🧰 Tools
🪛 dotenv-linter (4.0.0)

[warning] 179-179: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)


[warning] 180-180: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)


[warning] 181-181: [UnorderedKey] The PROTOCOL key should go before the TASKDEFINITION_FAMILY key

(UnorderedKey)


[warning] 182-182: [UnorderedKey] The AWS_ACCOUNT_ID key should go before the CLUSTER_NAME key

(UnorderedKey)


[warning] 182-182: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)


[warning] 183-183: [UnorderedKey] The S3_BUCKET_ARN key should go before the TASKDEFINITION_FAMILY key

(UnorderedKey)


[warning] 183-183: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)

🤖 Prompt for AI Agents
In .env.demo around lines 179 to 183: the new entries are missing quotes around
values, use inconsistent comment markers, and keys are out of alphabetical
order; update each variable value to be wrapped in double quotes (e.g.,
"CREDO-CONTROLLER-CLUSTER"), replace all '//' comments with '#' to match
dotenv/shell convention, and reorder the lines so keys are alphabetically sorted
(AWS_ACCOUNT_ID, CLUSTER_NAME, PROTOCOL, S3_BUCKET_ARN, TASKDEFINITION_FAMILY)
while keeping descriptive comments prefixed with '#' and preserving any
placeholder text.

Comment thread .env.sample
Comment on lines +200 to +202
CLUSTER_NAME=CREDO-CONTROLLER-CLUSTER # ECS cluster name for credo controller
TASKDEFINITION_FAMILY=CREDO-CONTROLLER-TASKDEFINITION # ECS taskdefinition name for credo controller
PROTOCOL=http
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Quote environment variable values and fix key ordering.

The newly added variables lack quotes around their values, inconsistent with dotenv formatting standards and existing quoted variables in the file (e.g., line 36: WALLET_STORAGE_USER='postgres'). Additionally, static analysis flags that PROTOCOL should be ordered before TASKDEFINITION_FAMILY alphabetically.

-CLUSTER_NAME=CREDO-CONTROLLER-CLUSTER  # ECS cluster name for credo controller
-TASKDEFINITION_FAMILY=CREDO-CONTROLLER-TASKDEFINITION # ECS taskdefinition name for credo controller
-PROTOCOL=http
+CLUSTER_NAME="CREDO-CONTROLLER-CLUSTER"  # ECS cluster name for credo controller
+PROTOCOL=http
+TASKDEFINITION_FAMILY="CREDO-CONTROLLER-TASKDEFINITION" # ECS taskdefinition name for credo controller

Committable suggestion skipped: line range outside the PR's diff.

🧰 Tools
🪛 dotenv-linter (4.0.0)

[warning] 200-200: [DuplicatedKey] The CLUSTER_NAME key is duplicated

(DuplicatedKey)


[warning] 200-200: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)


[warning] 201-201: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)


[warning] 202-202: [UnorderedKey] The PROTOCOL key should go before the TASKDEFINITION_FAMILY key

(UnorderedKey)

🤖 Prompt for AI Agents
In .env.sample around lines 200-202, the three added env vars are unquoted and
out of alphabetical order; update them to use the same single-quote style as
other entries (e.g., CLUSTER_NAME='CREDO-CONTROLLER-CLUSTER',
TASKDEFINITION_FAMILY='CREDO-CONTROLLER-TASKDEFINITION', PROTOCOL='http') and
reorder the keys so PROTOCOL appears before TASKDEFINITION_FAMILY to satisfy the
alphabetical/static-analysis requirement.

@pranalidhanavade pranalidhanavade merged commit c43651e into main Oct 24, 2025
8 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request Nov 20, 2025
@coderabbitai coderabbitai Bot mentioned this pull request Mar 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants