Skip to content

Comments

Fix for .env issues when getting setup with the repo#2612

Merged
nicktrn merged 1 commit intomainfrom
contributing-dotenv
Oct 17, 2025
Merged

Fix for .env issues when getting setup with the repo#2612
nicktrn merged 1 commit intomainfrom
contributing-dotenv

Conversation

@matt-aitken
Copy link
Member

  • The .env.example was missing required Clickhouse values.
  • A symlink was needed for .env from the root to the apps/webapp folder

- The .env.example was missing required Clickhouse values.
- A symlink was needed for .env from the root to the apps/webapp folder
@changeset-bot
Copy link

changeset-bot bot commented Oct 17, 2025

⚠️ No Changeset found

Latest commit: c129f4c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 17, 2025

Walkthrough

The pull request adds Clickhouse configuration support by introducing three new environment variables in .env.example (CLICKHOUSE_URL, RUN_REPLICATION_CLICKHOUSE_URL, and RUN_REPLICATION_ENABLED). A new .env file is created in the apps/webapp/ directory that references the parent-level environment configuration. The .gitignore file is updated to explicitly track the .env symlink via a negated pattern.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Rationale: The changes are lightweight configuration modifications with no runtime logic. Three files are affected—two configurations and one gitignore update—all following straightforward patterns. The modifications are homogeneous in nature (environment and build configuration only), requiring minimal contextual reasoning per file.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description is largely incomplete and does not follow the required template structure. While the author provides two brief bullet points describing what changed (missing Clickhouse values and needed symlink), the description is missing critical required sections including the issue reference ("Closes #"), the full checklist with contributing guide and testing confirmation, a dedicated Testing section describing test steps, and a properly formatted Changelog section. The description only contains the "what changed" information without adhering to the expected template format or completeness.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "Fix for .env issues when getting setup with the repo" is directly related to the main changes in the changeset. The PR addresses two specific .env setup issues: adding missing Clickhouse environment variables to .env.example and creating a symlink structure for the .env file from root to apps/webapp. The title is concise, clear, and a teammate scanning the history would immediately understand that this PR fixes environment configuration problems during repository setup.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch contributing-dotenv

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.

Copy link
Contributor

@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: 1

🧹 Nitpick comments (1)
.env.example (1)

16-19: Consider documenting Clickhouse variable purpose and cross-platform symlink notes.

The three new Clickhouse variables are now present in .env.example, addressing the PR objective. However, consider adding inline documentation for users unfamiliar with these variables. Additionally, the symlink approach used in apps/webapp/.env may face limitations on Windows (requires Developer Mode or admin privileges), so consider documenting any setup requirements in a README or CONTRIBUTING guide.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 885d2d3 and c129f4c.

📒 Files selected for processing (3)
  • .env.example (1 hunks)
  • apps/webapp/.env (1 hunks)
  • apps/webapp/.gitignore (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (23)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
apps/webapp/.gitignore (1)

12-13: Gitignore negation pattern is correct.

The negation pattern !.env will un-ignore the .env file so it can be tracked in Git. This is the right approach to ensure the symlink is not accidentally removed by gitignore cleaning. The comment is clear and helpful.

However, this depends on Line 1 of apps/webapp/.env being committed as a proper Git symlink—if that file is corrected to be a true symlink, this gitignore change will work as intended.

apps/webapp/.env (1)

1-1: No issues found. The file is correctly committed as a Git symlink.

The verification output confirms 120000 mode, which is the correct Git object type for symlinks. The webapp will properly resolve this symlink to access the parent directory's .env file as intended.

@nicktrn nicktrn merged commit 68d0037 into main Oct 17, 2025
56 of 60 checks passed
@nicktrn nicktrn deleted the contributing-dotenv branch October 17, 2025 10:49
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