feat: allow to use custom snakemake branch instead of conda version

Author: johanneskoester

README.md

@@ -28,6 +28,14 @@ Whether to run Snakemake or to generate a container image specification (in the
 
 Whether used disk space shall be printed if Snakemake fails. Can be either `true` or `false` (default: `false`).
 
+### `snakemake-version`
+
+Snakemake version to install from conda. Default `*` (latest available version from the configured channels).
+
+### `snakemake-branch`
+
+Optional Snakemake git branch to install from `https://github.com/snakemake/snakemake`. If set, this takes precedence over `snakemake-version` and Snakemake is installed from source via pip.
+
 ## Example usage
 
 ```yaml
@@ -47,6 +55,14 @@ Whether used disk space shall be printed if Snakemake fails. Can be either `true
     stagein: "" # additional preliminary commands to run (can be multiline)
     show-disk-usage-on-error: true
 
+- name: Testing with custom Snakemake branch
+  uses: snakemake/snakemake-github-action@v2
+  with:
+    directory: ".test"
+    snakefile: "workflow/Snakefile"
+    args: "--cores 1 --sdm conda --conda-cleanup-pkgs cache"
+    snakemake-branch: main
+
 - name: Create container file
   uses: snakemake/snakemake-github-action@v2
   with:

action.yml

@@ -29,15 +29,22 @@ inputs:
   show-disk-usage-on-error:
     description: Whether to return the used disk space on failing.
     required: false
-    default: false
+    default: "false"
   snakemake-version:
-    description: Snakemake version to use. If not specified, uses latest version. Pin a specific version (e.g., '8.25.5') for reproducibility.
+    description: |
+      Snakemake version to use. If not specified, uses latest version. Pin a specific version (e.g., '8.25.5') for reproducibility.
     required: false
     default: "*"
+  snakemake-branch:
+    description: |
+      Optional Snakemake git branch to install from https://github.com/snakemake/snakemake.
+      If set, this takes precedence over snakemake-version and Snakemake is installed via pip.
+    required: false
+    default: ""
   install-apptainer:
     description: Install Apptainer (true/false)
     required: false
-    default: false
+    default: "false"
 
 runs:
   using: "composite"
@@ -70,8 +77,18 @@ runs:
           - bioconda
           - nodefaults
         dependencies:
+        EOF
+
+        if [[ -n "${{ inputs.snakemake-branch }}" ]]; then
+          cat <<EOF >> .snakemake.environment.yaml
+          - python
+          - pip
+        EOF
+        else
+          cat <<EOF >> .snakemake.environment.yaml
           - snakemake ==${{ inputs.snakemake-version }}
         EOF
+        fi
 
     - name: Setup conda
       uses: conda-incubator/setup-miniconda@v3
@@ -82,6 +99,12 @@ runs:
         environment-file: .snakemake.environment.yaml
         activate-environment: snakemake
 
+    - name: Install snakemake from git branch
+      if: ${{ inputs.snakemake-branch != '' }}
+      shell: bash -el {0}
+      run: |
+        python -m pip install "git+https://github.com/snakemake/snakemake@${{ inputs.snakemake-branch }}"
+
     - name: Display snakemake version
       shell: bash -el {0}
       run: snakemake --version