Move README "setup" commands into Flox "activate" hook#801
Move README "setup" commands into Flox "activate" hook#801forstmeier merged 5 commits intomasterfrom
Conversation
📝 WalkthroughWalkthroughActivation hook now auto-creates and activates a local Python virtualenv, installs the git pre-commit hook if missing, and runs Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Greptile SummaryThis PR automates the local development setup by moving manual README steps into the Flox
Confidence Score: 5/5
|
| Filename | Overview |
|---|---|
| .flox/env/manifest.toml | Adds an on-activate hook block with a CI guard that creates/activates the Python venv, installs pre-commit, and runs mask development python install. Logic is sound and matches the lock file. |
| .flox/env/manifest.lock | Lock file on-activate hook is updated to match manifest.toml, including the if [[ -z "${CI}" ]] guard — addressing the prior review concern. |
| README.md | Setup section simplified from 8 manual steps to 4, correctly reflecting that flox activate now handles venv creation, pre-commit install, and dependency installation automatically. |
Reviews (4): Last reviewed commit: "Merge branch 'master' into consolidate-s..." | Re-trigger Greptile
There was a problem hiding this comment.
Pull request overview
This PR moves the manual development setup steps from the README into Flox’s on-activate hook so that entering the Flox environment performs initial repo setup automatically for local developers.
Changes:
- Simplifies README setup instructions to a short
flox activate+ Mask workflow. - Expands Flox
on-activatehook to create/activate a Python venv, install pre-commit hooks, and install Python deps. - Updates Flox lockfile hook content to reflect the new activation behavior.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
README.md |
Updates dev setup instructions to rely on Flox activation + Mask tasks. |
.flox/env/manifest.toml |
Adds local-only activation steps (venv creation, pre-commit install, python deps install). |
.flox/env/manifest.lock |
Updates the serialized on-activate hook stored in the lockfile. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Warning
CodeRabbit couldn't request changes on this pull request because it doesn't have sufficient GitHub permissions.
Please grant CodeRabbit Pull requests: Read and write permission and re-run the review.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 23: The README currently suggests a macOS-only command "brew install
flox"; update the setup step around that line to add a cross-platform note
telling non-macOS users to follow Flox's official installer docs (e.g., "on
Linux/other platforms, see https://flox.dev/docs/install or the official
installer instructions") so contributors who aren’t on macOS know where to
install Flox; keep the original brew line for macOS but append the fallback
sentence and a link for clarity.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: c18fe7b9-2e4f-4f6c-8763-01e911ae5d91
⛔ Files ignored due to path filters (1)
.flox/env/manifest.lockis excluded by!**/*.lock
📒 Files selected for processing (1)
README.md
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 3 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Overview
Changes
Context
Minor quality of life thing for new developers.
Summary by CodeRabbit
New Features
Documentation