Skip to content

docs: add instructions for testing feature branches with one-off Nix shell#170

Merged
ncrmro merged 2 commits intomainfrom
docs/nix-feature-branch-testing
Jan 27, 2026
Merged

docs: add instructions for testing feature branches with one-off Nix shell#170
ncrmro merged 2 commits intomainfrom
docs/nix-feature-branch-testing

Conversation

@ncrmro
Copy link
Collaborator

@ncrmro ncrmro commented Jan 27, 2026

No description provided.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds documentation for testing feature branches using Nix flakes directly from GitHub, allowing contributors to test branches without cloning or modifying their local environment.

Changes:

  • Added a new section "Test a Feature Branch with One-Off Nix Shell" to CONTRIBUTING.md
  • Provides examples of using nix run and nix develop with GitHub repository references
  • Includes use cases for reviewing PRs and testing experimental changes

CONTRIBUTING.md Outdated
Comment on lines 303 to 315
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
Copy link

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

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

The GitHub organization name should be Unsupervisedcom (with capital U and "com") to match the rest of the codebase. See README.md line 269 and doc/nix-flake.md line 91 for consistent usage.

Suggested change
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
nix run github:Unsupervisedcom/deepwork/feature-branch-name -- --help
# Enter a development shell with a specific branch
nix develop github:Unsupervisedcom/deepwork/feature-branch-name
# Run a specific command from a feature branch
nix develop github:Unsupervisedcom/deepwork/feature-branch-name --command deepwork install --platform claude
# Test against a specific commit
nix run github:Unsupervisedcom/deepwork/abc1234 -- --version
# Test against a PR (using the PR's head branch)
nix run github:Unsupervisedcom/deepwork/pr-author:feature-name -- --help

Copilot uses AI. Check for mistakes.
CONTRIBUTING.md Outdated
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
Copy link

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

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

The GitHub organization name should be Unsupervisedcom (with capital U and "com") to match the rest of the codebase. See README.md line 269 and doc/nix-flake.md line 91 for consistent usage.

Copilot uses AI. Check for mistakes.
CONTRIBUTING.md Outdated

```bash
# Quick test of the CLI
nix run github:unsupervised/deepwork/feat/new-parser -- install --platform claude --dry-run
Copy link

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

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

The GitHub organization name should be Unsupervisedcom (with capital U and "com") to match the rest of the codebase. See README.md line 269 and doc/nix-flake.md line 91 for consistent usage.

Copilot uses AI. Check for mistakes.
CONTRIBUTING.md Outdated
Comment on lines 325 to 326
nix develop github:unsupervised/deepwork/feat/new-parser
pytest tests/unit/core/test_parser.py -v
Copy link

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

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

The pytest command on this line appears to be a continuation of the previous nix develop command, but this is ambiguous. The nix develop command enters a new shell, so the pytest command would need to be run separately after entering that shell. Consider either: (1) making it clear these are separate steps by adding a comment like "# Then inside the shell:", or (2) using the --command flag instead: nix develop github:Unsupervisedcom/deepwork/feat/new-parser --command pytest tests/unit/core/test_parser.py -v

Suggested change
nix develop github:unsupervised/deepwork/feat/new-parser
pytest tests/unit/core/test_parser.py -v
nix develop github:unsupervised/deepwork/feat/new-parser --command pytest tests/unit/core/test_parser.py -v

Copilot uses AI. Check for mistakes.
CONTRIBUTING.md Outdated
Comment on lines 303 to 315
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
Copy link

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

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

The GitHub organization name used here (unsupervised) is inconsistent with the rest of the codebase. The README.md (line 269) and doc/nix-flake.md (line 91) both use Unsupervisedcom/deepwork for Nix commands. All examples in this section should use github:Unsupervisedcom/deepwork instead of github:unsupervised/deepwork to maintain consistency.

Suggested change
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
nix run github:Unsupervisedcom/deepwork/feature-branch-name -- --help
# Enter a development shell with a specific branch
nix develop github:Unsupervisedcom/deepwork/feature-branch-name
# Run a specific command from a feature branch
nix develop github:Unsupervisedcom/deepwork/feature-branch-name --command deepwork install --platform claude
# Test against a specific commit
nix run github:Unsupervisedcom/deepwork/abc1234 -- --version
# Test against a PR (using the PR's head branch)
nix run github:Unsupervisedcom/deepwork/pr-author:feature-name -- --help

Copilot uses AI. Check for mistakes.
CONTRIBUTING.md Outdated
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
Copy link

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

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

The GitHub organization name should be Unsupervisedcom (with capital U and "com") to match the rest of the codebase. See README.md line 269 and doc/nix-flake.md line 91 for consistent usage.

Copilot uses AI. Check for mistakes.
CONTRIBUTING.md Outdated
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
Copy link

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

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

The GitHub organization name should be Unsupervisedcom (with capital U and "com") to match the rest of the codebase. See README.md line 269 and doc/nix-flake.md line 91 for consistent usage.

Copilot uses AI. Check for mistakes.
CONTRIBUTING.md Outdated
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
Copy link

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

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

The GitHub organization name should be Unsupervisedcom (with capital U and "com") to match the rest of the codebase. See README.md line 269 and doc/nix-flake.md line 91 for consistent usage.

Copilot uses AI. Check for mistakes.
CONTRIBUTING.md Outdated
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
Copy link

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

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

The syntax github:unsupervised/deepwork/pr-author:feature-name is not valid Nix flake syntax. To test a PR branch from a fork, you should use the fork owner's GitHub organization: github:pr-author/deepwork/feature-name (assuming the PR is from a fork). If the PR is from a branch in the same repository, use: github:Unsupervisedcom/deepwork/feature-name

Suggested change
nix run github:unsupervised/deepwork/pr-author:feature-name -- --help
# If the PR is from a fork:
nix run github:pr-author/deepwork/feature-name -- --help
# If the PR is from a branch in this repository:
nix run github:Unsupervisedcom/deepwork/feature-name -- --help

Copilot uses AI. Check for mistakes.
@ncrmro
Copy link
Collaborator Author

ncrmro commented Jan 27, 2026

@copilot open a new pull request to apply changes based on the comments in this thread

Note it should be unsueprvisedcom (it case doesn't matter)

Copy link
Contributor

Copilot AI commented Jan 27, 2026

@ncrmro I've opened a new pull request, #171, to work on those changes. Once the pull request is ready, I'll request review from you.

@ncrmro ncrmro closed this Jan 27, 2026
@ncrmro ncrmro reopened this Jan 27, 2026
* 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>
@github-actions
Copy link
Contributor


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you all sign our Developer Certificate of Origin before we can accept your contribution. You can sign the DCO by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


1 out of 2 committers have signed the DCO.
✅ (ncrmro)[https://github.com/ncrmro]
❌ @Copilot
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the DCO Assistant Lite bot.

@ncrmro ncrmro merged commit 14a9ebd into main Jan 27, 2026
3 of 4 checks passed
@ncrmro ncrmro deleted the docs/nix-feature-branch-testing branch January 27, 2026 17:59
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.

3 participants