Skip to content

add paths in output directive in cellranger cout module #7615

add paths in output directive in cellranger cout module

add paths in output directive in cellranger cout module #7615

Workflow file for this run

name: Run tests
on:
push:
branches: [master]
pull_request:
branches: [master]
merge_group:
types: [checks_requested]
branches: [master]
workflow_dispatch:
inputs:
runners:
description: "Runners to test on"
type: choice
options:
- "ubuntu-latest"
- "self-hosted"
default: "self-hosted"
# Cancel if a newer run is started
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
env:
NXF_SINGULARITY_CACHEDIR: ${{ github.workspace }}/.singularity
NXF_SINGULARITY_LIBRARYDIR: ${{ github.workspace }}/.singularity
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
- uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5
- uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
# FIXME Flip this off once we get to less than a couple hundred. Adding
# this so it will only run against changed files. It'll make it much
# easier to fix these as they come up rather than everything at once.
with:
extra_args: ""
prettier:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
- name: Install NodeJS
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4
with:
node-version: "20"
- name: Install Prettier
run: npm install -g [email protected]
- name: Run Prettier --check
run: prettier --check .
editorconfig:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
- uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4
with:
node-version: "20"
- name: Install editorconfig-checker
run: npm install -g editorconfig-checker
- name: Run ECLint check
run: editorconfig-checker -exclude README.md $(git ls-files | grep -v test)
pytest-changes:
name: pytest-changes
runs-on: ubuntu-latest
outputs:
# Expose matched filters as job 'modules' output variable
modules: ${{ steps.filter.outputs.changes }}
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
with:
fetch-depth: 2 # To retrieve the preceding commit.
# TODO: change back to using dorny/paths-filter when https://github.com/dorny/paths-filter/pull/133 is implemented
- uses: mirpedrol/paths-filter@main
id: filter
with:
filters: "tests/config/pytest_modules.yml"
token: ""
nf-test-changes:
name: nf-test-changes
runs-on: ubuntu-latest
outputs:
# Expose matched filters as job 'modules' output variable
modules: ${{ steps.filter.outputs.changes }}
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
with:
fetch-depth: 2 # To retrieve the preceding commit.
- name: Combine all tags.yml files
id: get_tags
run: find . -name "tags.yml" -not -path "./.github/*" -exec cat {} + > .github/tags.yml
- name: debug
run: cat .github/tags.yml
# TODO: change back to using dorny/paths-filter when https://github.com/dorny/paths-filter/pull/133 is implemented
- uses: mirpedrol/paths-filter@main
id: filter
with:
filters: ".github/tags.yml"
token: ""
nf-core-lint:
runs-on: ${{ github.event.inputs.runners || 'self-hosted' }}
name: nf-core-lint
needs: [pytest-changes, nf-test-changes]
if: ${{ (needs.pytest-changes.outputs.modules != '[]') || (needs.nf-test-changes.outputs.modules != '[]') }}
strategy:
fail-fast: false
matrix:
tags:
[
"${{ fromJson(needs.pytest-changes.outputs.modules) }}",
"${{ fromJson(needs.nf-test-changes.outputs.modules) }}",
]
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
- name: Set up Python
uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5
with:
python-version: "3.11"
- uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 # v4
id: cache-pip
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip
restore-keys: |
${{ runner.os }}-pip
- name: Install pip
if: steps.cache-pip.outputs.cache-hit != 'true'
run: python -m pip install --upgrade pip
- uses: actions/setup-java@9704b39bf258b59bc04b50fa2dd55e9ed76b47a8 # v4
with:
distribution: "temurin"
java-version: "17"
- name: Setup Nextflow
uses: nf-core/setup-nextflow@v2
- name: Install nf-core tools development version
run: python -m pip install --upgrade --force-reinstall git+https://github.com/nf-core/tools.git@dev
- name: Lint module ${{ matrix.tags }}
run: nf-core modules lint ${{ matrix.tags }}
if: ${{ !startsWith(matrix.tags, 'subworkflows/') }}
- name: Remove substring from matrix.tags
id: remove_substring
run: echo subworkflow_names=$(echo "${{ matrix.tags }}" | sed 's/subworkflows\///g') >> $GITHUB_OUTPUT
- name: Lint subworkflow ${{ matrix.tags }}
run: nf-core subworkflows lint ${{steps.remove_substring.outputs.subworkflow_names}}
if: ${{ startsWith(matrix.tags, 'subworkflows/') }}
pytest:
runs-on: ${{ github.event.inputs.runners || 'self-hosted' }}
name: pytest
needs: [pytest-changes]
if: needs.pytest-changes.outputs.modules != '[]'
strategy:
fail-fast: false
matrix:
tags: ["${{ fromJson(needs.pytest-changes.outputs.modules) }}"]
profile: [conda, docker, singularity]
exclude:
- tags: nf-test
- profile: conda
tags: annotsv
- profile: conda
tags: backsub
- profile: conda
tags: bases2fastq
- profile: singularity
tags: bases2fastq
- profile: conda
tags: basicpy
- profile: conda
tags: bcl2fastq
- profile: conda
tags: bclconvert
- profile: conda
tags: bwa/aln
- profile: conda
tags: bwa/index
- profile: conda
tags: bwa/mem
- profile: conda
tags: bwa/sampe
- profile: conda
tags: bwa/samse
- profile: conda
tags: cellpose
- profile: conda
tags: cellranger/count
- profile: conda
tags: cellranger/mkfastq
- profile: conda
tags: cellranger/mkgtf
- profile: conda
tags: cellranger/mkref
- profile: conda
tags: cellranger/mkvdjref
- profile: conda
tags: cellranger/multi
- profile: conda
tags: cellranger/vdj
- profile: conda
tags: cellrangerarc/count
- profile: conda
tags: cellrangerarc/mkfastq
- profile: conda
tags: cellrangerarc/mkgtf
- profile: conda
tags: cellrangerarc/mkref
- profile: conda
tags: cellrangeratac/count
- profile: conda
tags: cellrangeratac/mkfastq
- profile: conda
tags: cellrangeratac/mkref
- profile: conda
tags: checkm2/databasedownload
- profile: conda
tags: checkm2/predict
- profile: conda
tags: controlfreec/makegraph2
- profile: conda
tags: coreograph
- profile: conda
tags: deepcell/mesmer
- profile: conda
tags: deepvariant
- profile: conda
tags: fastani
- profile: conda
tags: fastk/fastk
- profile: conda
tags: fastk/histex
- profile: conda
tags: fastk/merge
- profile: conda
tags: fcs/fcsadaptor
- profile: conda
tags: fcs/fcsgx
- profile: conda
tags: gatk4/cnnscorevariants
- profile: conda
tags: gatk4/determinegermlinecontigploidy
- profile: singularity
tags: gatk4/determinegermlinecontigploidy
- profile: conda
tags: gatk4/germlinecnvcaller
- profile: conda
tags: gatk4/postprocessgermlinecnvcalls
- profile: conda
tags: genescopefk
- profile: conda
tags: happy/sompy
- profile: conda
tags: hlala/preparegraph
- profile: conda
tags: ilastik/multicut
- profile: conda
tags: ilastik/pixelclassification
- profile: conda
tags: imputeme/vcftoprs
- profile: conda
tags: islandpath
- profile: conda
tags: manta/convertinversion
- profile: conda
tags: mcquant
- profile: conda
tags: medaka
- profile: conda
tags: merquryfk/katcomp
- profile: conda
tags: merquryfk/katgc
- profile: conda
tags: merquryfk/merquryfk
- profile: conda
tags: merquryfk/ploidyplot
- profile: conda
tags: minimap2/align
- profile: conda
tags: mitohifi/findmitoreference
- profile: conda
tags: mitohifi/mitohifi
- profile: conda
tags: nanoplot
- profile: conda
tags: ncbitools/vecscreen
- profile: conda
tags: parabricks/applybqsr
- profile: conda
tags: parabricks/dbsnp
- profile: conda
tags: parabricks/deepvariant
- profile: conda
tags: parabricks/fq2bam
- profile: conda
tags: parabricks/genotypegvcf
- profile: conda
tags: parabricks/haplotypecaller
- profile: conda
tags: parabricks/indexgvcf
- profile: conda
tags: parabricks/mutectcaller
- profile: conda
tags: picard/collecthsmetrics
- profile: conda
tags: picard/collectwgsmetrics
- profile: conda
tags: scimap/mcmicro
- profile: conda
tags: sentieon/applyvarcal
- profile: conda
tags: sentieon/bwaindex
- profile: conda
tags: sentieon/bwamem
- profile: conda
tags: sentieon/datametrics
- profile: conda
tags: sentieon/dedup
- profile: conda
tags: sentieon/dnamodelapply
- profile: conda
tags: sentieon/dnascope
- profile: conda
tags: sentieon/gvcftyper
- profile: conda
tags: sentieon/haplotyper
- profile: conda
tags: sentieon/readwriter
- profile: conda
tags: sentieon/tnfilter
- profile: conda
tags: sentieon/tnhaplotyper2
- profile: conda
tags: sentieon/tnscope
- profile: conda
tags: sentieon/varcal
- profile: conda
tags: sentieon/wgsmetrics
- profile: conda
tags: subworkflows/bam_qc_picard
- profile: conda
tags: subworkflows/bcl_demultiplex
- profile: conda
tags: subworkflows/fasta_clean_fcs
- profile: conda
tags: svanalyzer/svbenchmark
- profile: conda
tags: universc
- profile: singularity
tags: universc
- profile: conda
tags: vt/decompose
env:
NXF_ANSI_LOG: false
SENTIEON_LICENSE_BASE64: ${{ secrets.SENTIEON_LICENSE_BASE64 }}
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
- name: Set up Python
uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5
with:
python-version: "3.11"
- uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 # v4
id: cache-pip-pytest
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-pytest
restore-keys: |
${{ runner.os }}-pip-pytest
- name: Install Python dependencies
if: steps.cache-pip-pytest.outputs.cache-hit != 'true'
run: python -m pip install --upgrade pip pytest-workflow cryptography
- uses: actions/setup-java@9704b39bf258b59bc04b50fa2dd55e9ed76b47a8 # v4
with:
distribution: "temurin"
java-version: "17"
- name: Setup Nextflow ${{ matrix.NXF_VER }}
uses: nf-core/setup-nextflow@v2
with:
version: "${{ matrix.NXF_VER }}"
- name: Setup apptainer
if: matrix.profile == 'singularity'
uses: eWaterCycle/setup-apptainer@main
- name: Set up Singularity
if: matrix.profile == 'singularity'
run: |
mkdir -p $NXF_SINGULARITY_CACHEDIR
mkdir -p $NXF_SINGULARITY_LIBRARYDIR
- name: Set up miniconda
uses: conda-incubator/setup-miniconda@030178870c779d9e5e1b4e563269f3aa69b04081 # v3
with:
miniconda-version: "latest"
channels: conda-forge,bioconda,defaults
python-version: ${{ matrix.python-version }}
- name: Conda setup
run: |
conda clean -a
conda install -n base conda-libmamba-solver
conda config --set solver libmamba
echo $(realpath $CONDA)/condabin >> $GITHUB_PATH
echo $(realpath python) >> $GITHUB_PATH
# Set up secrets
- name: Set up nextflow secrets
if: env.SENTIEON_LICENSE_BASE64 != null
run: |
nextflow secrets set SENTIEON_LICENSE_BASE64 ${{ secrets.SENTIEON_LICENSE_BASE64 }}
nextflow secrets set SENTIEON_AUTH_MECH_BASE64 ${{ secrets.SENTIEON_AUTH_MECH_BASE64 }}
SENTIEON_ENCRYPTION_KEY=$(echo -n "${{ secrets.ENCRYPTION_KEY_BASE64 }}" | base64 -d)
SENTIEON_LICENSE_MESSAGE=$(echo -n "${{ secrets.LICENSE_MESSAGE_BASE64 }}" | base64 -d)
SENTIEON_AUTH_DATA=$(python3 tests/modules/nf-core/sentieon/license_message.py encrypt --key "$SENTIEON_ENCRYPTION_KEY" --message "$SENTIEON_LICENSE_MESSAGE")
SENTIEON_AUTH_DATA_BASE64=$(echo -n "$SENTIEON_AUTH_DATA" | base64 -w 0)
nextflow secrets set SENTIEON_AUTH_DATA_BASE64 $SENTIEON_AUTH_DATA_BASE64
# Test the module
- name: Run pytest-workflow
# only use one thread for pytest-workflow to avoid race condition on conda cache.
run: TMPDIR=~ PROFILE=${{ matrix.profile }} pytest --tag ${{ matrix.tags }} --symlink --kwdof --git-aware --color=yes
- name: Output log on failure
if: failure()
run: |
sudo apt-get update > /dev/null
sudo apt-get install bat > /dev/null
batcat --decorations=always --color=always /home/ubuntu/pytest_workflow_*/*/log.{out,err}
- name: Setting global variables
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7
id: parsed
with:
script: |
return '${{ matrix.tags }}'.toLowerCase().replaceAll(/\//g, '-').trim('-').trim('"')
result-encoding: string
- name: Upload logs on failure
if: failure()
uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4
with:
name: logs-${{ matrix.profile }}-${{ steps.parsed.outputs.result }}
path: |
/home/ubuntu/pytest_workflow_*/*/.nextflow.log
/home/ubuntu/pytest_workflow_*/*/log.out
/home/ubuntu/pytest_workflow_*/*/log.err
/home/ubuntu/pytest_workflow_*/*/work
!/home/ubuntu/pytest_workflow_*/*/work/conda
!/home/ubuntu/pytest_workflow_*/*/work/singularity
!${{ github.workspace }}/.singularity
nf-test:
runs-on: ${{ github.event.inputs.runners || 'self-hosted' }}
name: nf-test
needs: [nf-test-changes]
if: needs.nf-test-changes.outputs.modules != '[]'
strategy:
fail-fast: false
matrix:
tags: ["${{ fromJson(needs.nf-test-changes.outputs.modules) }}"]
profile: [conda, docker, singularity]
exclude:
- tags: nf-test
- profile: conda
tags: annotsv
- profile: conda
tags: happy/sompy
- profile: conda
tags: backsub
- profile: conda
tags: bakta/bakta
- profile: conda
tags: bakta/baktadbdownload
- profile: conda
tags: bases2fastq
- profile: conda
tags: bcl2fastq
- profile: conda
tags: bclconvert
- profile: conda
tags: cellpose
- profile: conda
tags: cellranger/count
- profile: conda
tags: cellranger/mkfastq
- profile: conda
tags: cellranger/mkgtf
- profile: conda
tags: cellranger/mkref
- profile: conda
tags: custom/dumpsoftwareversions
- profile: conda
tags: deepcell/mesmer
- profile: conda
tags: deepvariant
- profile: conda
tags: ensemblvep/vep
- profile: conda
tags: fastk/fastk
- profile: conda
tags: fastk/histex
- profile: conda
tags: fastk/merge
- profile: conda
tags: fcs/fcsadaptor
- profile: conda
tags: fcs/fcsgx
- profile: conda
tags: ganon/buildcustom
- profile: conda
tags: ganon/classify
- profile: conda
tags: ganon/report
- profile: conda
tags: ganon/table
- profile: conda
tags: gatk4/cnnscorevariants
- profile: conda
tags: gatk4/determinegermlinecontigploidy
- profile: conda
tags: genescopefk
- profile: conda
tags: ilastik/multicut
- profile: conda
tags: ilastik/pixelclassification
- profile: conda
tags: imputeme/vcftoprs
- profile: conda
tags: merquryfk/katcomp
- profile: conda
tags: merquryfk/katgc
- profile: conda
tags: merquryfk/merquryfk
- profile: conda
tags: merquryfk/ploidyplot
- profile: conda
tags: quartonotebook
- profile: conda
tags: sentieon/bwaindex
- profile: conda
tags: sentieon/bwamem
- profile: conda
tags: spaceranger/mkgtf
- profile: conda
tags: spaceranger/mkref
- profile: conda
tags: spaceranger/count
- profile: conda
tags: svanalyzer/svbenchmark
- profile: conda
tags: universc
- profile: singularity
tags: universc
- profile: conda
tags: vt/decompose
- profile: conda
tags: subworkflows/vcf_annotate_ensemblvep
- profile: singularity
tags: bases2fastq
env:
NXF_ANSI_LOG: false
SENTIEON_LICENSE_BASE64: ${{ secrets.SENTIEON_LICENSE_BASE64 }}
NFTEST_VER: "0.8.4"
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
- uses: actions/setup-java@9704b39bf258b59bc04b50fa2dd55e9ed76b47a8 # v4
with:
distribution: "temurin"
java-version: "17"
- name: Setup Nextflow
uses: nf-core/setup-nextflow@v2
- name: Install nf-test
uses: nf-core/setup-nf-test@v1
- name: Setup apptainer
if: matrix.profile == 'singularity'
uses: eWaterCycle/setup-apptainer@main
- name: Set up Singularity
if: matrix.profile == 'singularity'
run: |
mkdir -p $NXF_SINGULARITY_CACHEDIR
mkdir -p $NXF_SINGULARITY_LIBRARYDIR
- name: Set up Python
uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5
with:
python-version: "3.11"
- uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 # v4
id: cache-pip-pdiff
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-pdiff
restore-keys: |
${{ runner.os }}-pip-pdiff
- name: Install Python dependencies
if: steps.cache-pip-pdiff.outputs.cache-hit != 'true'
run: python -m pip install --upgrade pip pdiff cryptography
- name: Set up miniconda
uses: conda-incubator/setup-miniconda@030178870c779d9e5e1b4e563269f3aa69b04081 # v3
with:
miniconda-version: "latest"
auto-update-conda: true
channels: conda-forge,bioconda,defaults
python-version: ${{ matrix.python-version }}
- name: Conda setup
run: |
conda clean -a
conda install -n base conda-libmamba-solver
conda config --set solver libmamba
echo $(realpath $CONDA)/condabin >> $GITHUB_PATH
echo $(realpath python) >> $GITHUB_PATH
# Set up secrets
- name: Set up nextflow secrets
if: env.SENTIEON_LICENSE_BASE64 != null
run: |
nextflow secrets set SENTIEON_LICENSE_BASE64 ${{ secrets.SENTIEON_LICENSE_BASE64 }}
nextflow secrets set SENTIEON_AUTH_MECH_BASE64 ${{ secrets.SENTIEON_AUTH_MECH_BASE64 }}
SENTIEON_ENCRYPTION_KEY=$(echo -n "${{ secrets.ENCRYPTION_KEY_BASE64 }}" | base64 -d)
SENTIEON_LICENSE_MESSAGE=$(echo -n "${{ secrets.LICENSE_MESSAGE_BASE64 }}" | base64 -d)
SENTIEON_AUTH_DATA=$(python3 tests/modules/nf-core/sentieon/license_message.py encrypt --key "$SENTIEON_ENCRYPTION_KEY" --message "$SENTIEON_LICENSE_MESSAGE")
SENTIEON_AUTH_DATA_BASE64=$(echo -n "$SENTIEON_AUTH_DATA" | base64 -w 0)
nextflow secrets set SENTIEON_AUTH_DATA_BASE64 $SENTIEON_AUTH_DATA_BASE64
# Test the module
- name: Run nf-test
env:
NFT_DIFF: "pdiff"
NFT_DIFF_ARGS: "--line-numbers --width 120 --expand-tabs=2"
run: |
# use "docker_self_hosted" if it runs on self-hosted runner and matrix.profile=docker
if [ "${{ matrix.profile }}" == "docker" ]; then
PROFILE="docker_self_hosted"
else
PROFILE=${{ matrix.profile }}
fi
NFT_WORKDIR=~ \
nf-test test \
--profile=$PROFILE \
--tag ${{ matrix.tags }} \
--tap=test.tap \
--verbose
- uses: pcolby/tap-summary@0959cbe1d4422e62afc65778cdaea6716c41d936 # v1
with:
path: >-
test.tap
- name: Clean up
if: always()
run: |
sudo rm -rf /home/ubuntu/tests/
confirm-pass:
runs-on: ubuntu-latest
needs: [prettier, editorconfig, pytest-changes, nf-core-lint, pytest, nf-test-changes, nf-test]
if: always()
steps:
- name: All tests ok
if: ${{ success() || !contains(needs.*.result, 'failure') }}
run: exit 0
- name: One or more tests failed
if: ${{ contains(needs.*.result, 'failure') }}
run: exit 1
- name: debug-print
if: always()
run: |
echo "toJSON(needs) = ${{ toJSON(needs) }}"
echo "toJSON(needs.*.result) = ${{ toJSON(needs.*.result) }}"