feat: allow to use custom snakemake branch instead of conda version#53
feat: allow to use custom snakemake branch instead of conda version#53johanneskoester merged 3 commits intomasterfrom
Conversation
📝 WalkthroughWalkthroughThe PR adds support for installing Snakemake from a git branch via a new Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
action.yml (1)
102-106: Consider pinning Snakemake's dependencies or adding installation verification.The pip install from git works, but a few observations:
- If the branch name doesn't exist, pip will fail with an error message that may not be immediately clear to users.
- Snakemake has many dependencies that will be resolved by pip rather than conda, which could lead to different behavior than the conda-installed version.
These are acceptable trade-offs for a feature explicitly designed for testing custom branches, but you might want to add a brief echo statement before the install to clarify what's happening.
💡 Optional: Add informative message before install
- name: Install snakemake from git branch if: ${{ inputs.snakemake-branch != '' }} shell: bash -el {0} run: | + echo "Installing Snakemake from branch: ${{ inputs.snakemake-branch }}" python -m pip install "git+https://github.com/snakemake/snakemake@${{ inputs.snakemake-branch }}"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@action.yml` around lines 102 - 106, The "Install snakemake from git branch" step that installs via python -m pip install "git+https://github.com/snakemake/snakemake@${{ inputs.snakemake-branch }}" should be made more transparent and resilient: add an echo or printf before the install indicating which branch is being installed (referencing the step name and inputs.snakemake-branch), then after the pip install run a quick verification such as checking the exit code and running python -m pip show snakemake or snakemake --version to confirm installation succeeded; optionally, if you want stricter reproducibility, consider adding pinned dependency constraints or a requirements file reference to the pip install command to avoid unexpected dependency resolution differences from the conda build.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@action.yml`:
- Around line 102-106: The "Install snakemake from git branch" step that
installs via python -m pip install
"git+https://github.com/snakemake/snakemake@${{ inputs.snakemake-branch }}"
should be made more transparent and resilient: add an echo or printf before the
install indicating which branch is being installed (referencing the step name
and inputs.snakemake-branch), then after the pip install run a quick
verification such as checking the exit code and running python -m pip show
snakemake or snakemake --version to confirm installation succeeded; optionally,
if you want stricter reproducibility, consider adding pinned dependency
constraints or a requirements file reference to the pip install command to avoid
unexpected dependency resolution differences from the conda build.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 3824ff98-159b-4367-8b0b-64a759f0cf60
📒 Files selected for processing (3)
.github/workflows/main.ymlREADME.mdaction.yml
Summary by CodeRabbit
New Features
Documentation
Chores