From 5e337eba74dc79c5890bb4d68fc75640200807c0 Mon Sep 17 00:00:00 2001 From: Nicholas Romero Date: Tue, 27 Jan 2026 11:25:40 -0600 Subject: [PATCH 1/2] docs: add instructions for testing feature branches with one-off Nix shell --- CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12309868..4a79f8fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -291,6 +291,43 @@ claude # Start Claude Code /deepwork.define ``` +### 5. Test a Feature Branch with One-Off Nix Shell + +You can test a feature branch directly from GitHub without cloning or modifying your local environment. This is useful for: +- Reviewing someone else's PR +- Testing a feature branch before merging +- Trying out experimental changes without affecting your setup + +```bash +# Run DeepWork CLI directly from a feature branch +nix run github:unsupervised/deepwork/feature-branch-name -- --help + +# Enter a development shell with a specific branch +nix develop github:unsupervised/deepwork/feature-branch-name + +# Run a specific command from a feature branch +nix develop github:unsupervised/deepwork/feature-branch-name --command deepwork install --platform claude + +# Test against a specific commit +nix run github:unsupervised/deepwork/abc1234 -- --version + +# Test against a PR (using the PR's head branch) +nix run github:unsupervised/deepwork/pr-author:feature-name -- --help +``` + +For example, to test a branch named `feat/new-parser`: + +```bash +# Quick test of the CLI +nix run github:unsupervised/deepwork/feat/new-parser -- install --platform claude --dry-run + +# Or enter a full development shell to run tests +nix develop github:unsupervised/deepwork/feat/new-parser +pytest tests/unit/core/test_parser.py -v +``` + +**Note**: The first run will take longer as Nix fetches and builds the branch. Subsequent runs use the cached build. + ## Running Tests DeepWork has a comprehensive test suite with 568+ tests. From a55bb4821a0f0ea69280f92166d8386b3718e465 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Tue, 27 Jan 2026 11:55:05 -0600 Subject: [PATCH 2/2] Fix GitHub organization name consistency in Nix flake examples (#171) * Initial plan * Fix GitHub organization name consistency in CONTRIBUTING.md Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com> --- CONTRIBUTING.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4a79f8fd..a86ffe4a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -300,30 +300,31 @@ You can test a feature branch directly from GitHub without cloning or modifying ```bash # Run DeepWork CLI directly from a feature branch -nix run github:unsupervised/deepwork/feature-branch-name -- --help +nix run github:Unsupervisedcom/deepwork/feature-branch-name -- --help # Enter a development shell with a specific branch -nix develop github:unsupervised/deepwork/feature-branch-name +nix develop github:Unsupervisedcom/deepwork/feature-branch-name # Run a specific command from a feature branch -nix develop github:unsupervised/deepwork/feature-branch-name --command deepwork install --platform claude +nix develop github:Unsupervisedcom/deepwork/feature-branch-name --command deepwork install --platform claude # Test against a specific commit -nix run github:unsupervised/deepwork/abc1234 -- --version +nix run github:Unsupervisedcom/deepwork/abc1234 -- --version -# Test against a PR (using the PR's head branch) -nix run github:unsupervised/deepwork/pr-author:feature-name -- --help +# Test against a PR from a fork +nix run github:pr-author/deepwork/feature-name -- --help +# Or if the PR is from a branch in this repository: +nix run github:Unsupervisedcom/deepwork/feature-name -- --help ``` For example, to test a branch named `feat/new-parser`: ```bash # Quick test of the CLI -nix run github:unsupervised/deepwork/feat/new-parser -- install --platform claude --dry-run +nix run github:Unsupervisedcom/deepwork/feat/new-parser -- install --platform claude --dry-run -# Or enter a full development shell to run tests -nix develop github:unsupervised/deepwork/feat/new-parser -pytest tests/unit/core/test_parser.py -v +# Or enter a full development shell to run tests and run a specific test +nix develop github:Unsupervisedcom/deepwork/feat/new-parser --command pytest tests/unit/core/test_parser.py -v ``` **Note**: The first run will take longer as Nix fetches and builds the branch. Subsequent runs use the cached build.