docs: add instructions for testing feature branches with one-off Nix shell#170
docs: add instructions for testing feature branches with one-off Nix shell#170
Conversation
There was a problem hiding this comment.
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 runandnix developwith GitHub repository references - Includes use cases for reviewing PRs and testing experimental changes
CONTRIBUTING.md
Outdated
| 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 |
There was a problem hiding this comment.
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.
| 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 |
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 |
There was a problem hiding this comment.
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.
CONTRIBUTING.md
Outdated
|
|
||
| ```bash | ||
| # Quick test of the CLI | ||
| nix run github:unsupervised/deepwork/feat/new-parser -- install --platform claude --dry-run |
There was a problem hiding this comment.
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.
CONTRIBUTING.md
Outdated
| nix develop github:unsupervised/deepwork/feat/new-parser | ||
| pytest tests/unit/core/test_parser.py -v |
There was a problem hiding this comment.
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
| 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 |
CONTRIBUTING.md
Outdated
| 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 |
There was a problem hiding this comment.
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.
| 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 |
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 |
There was a problem hiding this comment.
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.
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 |
There was a problem hiding this comment.
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.
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 |
There was a problem hiding this comment.
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.
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 |
There was a problem hiding this comment.
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
| 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 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) |
* 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>
|
I have read the CLA Document and I hereby sign the CLA 1 out of 2 committers have signed the DCO. |
No description provided.