Skip to content

Commit 0612068

Browse files
authored
Merge pull request #74 from MaxUlysse/CLEANUP
Remove unused scripts and improve CI
2 parents e2b3101 + 5355c1e commit 0612068

File tree

11 files changed

+224
-341
lines changed

11 files changed

+224
-341
lines changed

.github/workflows/ci-extra.yml

Lines changed: 0 additions & 87 deletions
This file was deleted.

.github/workflows/ci.yml

Lines changed: 107 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,110 @@ jobs:
2121
docker tag nfcore/sarek:dev nfcore/sarek:dev
2222
- name: Run test
2323
run: |
24-
nextflow run ${GITHUB_WORKSPACE} -profile test,docker
24+
nextflow run ${GITHUB_WORKSPACE} -profile test,docker
25+
annotation:
26+
runs-on: ubuntu-18.04
27+
strategy:
28+
matrix:
29+
annotator: [snpeff]
30+
specie: [GRCh37]
31+
steps:
32+
- uses: actions/checkout@v1
33+
- name: Install Nextflow
34+
run: |
35+
wget -qO- get.nextflow.io | bash
36+
sudo mv nextflow /usr/local/bin/
37+
env:
38+
NXF_VER: '19.10.0'
39+
- name: Download and tag images
40+
run: |
41+
docker pull nfcore/sarek:dev
42+
docker tag nfcore/sarek:dev nfcore/sarek:dev
43+
docker pull nfcore/sarek${{ matrix.annotator }}:dev.${{ matrix.specie }}
44+
docker tag nfcore/sarek${{ matrix.annotator }}:dev.${{ matrix.specie }} nfcore/sarek${{ matrix.annotator }}:dev.${{ matrix.specie }}
45+
- name: Run annotation test
46+
run: |
47+
nextflow run . -profile test_annotation,docker --verbose --tools ${{ matrix.annotator }}
48+
germline:
49+
runs-on: ubuntu-18.04
50+
steps:
51+
- uses: actions/checkout@v1
52+
- name: Install Nextflow
53+
run: |
54+
wget -qO- get.nextflow.io | bash
55+
sudo mv nextflow /usr/local/bin/
56+
env:
57+
NXF_VER: '19.10.0'
58+
- name: Download and tag image
59+
run: |
60+
docker pull nfcore/sarek:dev
61+
docker tag nfcore/sarek:dev nfcore/sarek:dev
62+
- name: Get test data
63+
run: |
64+
git clone --single-branch --branch sarek https://github.com/nf-core/test-datasets.git data
65+
- name: Run germline test
66+
run: |
67+
nextflow run . -profile test,docker --input data/testdata/tiny/normal
68+
nextflow run . -profile test,docker --input=false --step recalibrate -resume
69+
nextflow run . -profile test,docker --input=false --step variantCalling
70+
minimal:
71+
runs-on: ubuntu-18.04
72+
strategy:
73+
matrix:
74+
genome: [smallerGRCh37, minimalGRCh37]
75+
intervals: [--no_intervals, '']
76+
steps:
77+
- uses: actions/checkout@v1
78+
- name: Install Nextflow
79+
run: |
80+
wget -qO- get.nextflow.io | bash
81+
sudo mv nextflow /usr/local/bin/
82+
env:
83+
NXF_VER: '19.10.0'
84+
- name: Download and tag image
85+
run: |
86+
docker pull nfcore/sarek:dev
87+
docker tag nfcore/sarek:dev nfcore/sarek:dev
88+
- name: Run test for minimal genomes
89+
run: |
90+
nextflow run . -profile test,docker --skipQC all --verbose --genome ${{ matrix.genome }} ${{ matrix.intervals }} --tools Manta,mpileup,Strelka
91+
profile:
92+
runs-on: ubuntu-18.04
93+
strategy:
94+
matrix:
95+
profile: [test_splitfastq, test_targeted]
96+
steps:
97+
- uses: actions/checkout@v1
98+
- name: Install Nextflow
99+
run: |
100+
wget -qO- get.nextflow.io | bash
101+
sudo mv nextflow /usr/local/bin/
102+
env:
103+
NXF_VER: '19.10.0'
104+
- name: Download and tag image
105+
run: |
106+
docker pull nfcore/sarek:dev
107+
docker tag nfcore/sarek:dev nfcore/sarek:dev
108+
- name: Run targeted and splitfastq tests
109+
run: |
110+
nextflow run . -profile ${{ matrix.profile }},docker --verbose
111+
tools:
112+
runs-on: ubuntu-18.04
113+
strategy:
114+
matrix:
115+
tool: [Haplotypecaller, Freebayes, Manta, mpileup, Mutect2, Strelka]
116+
steps:
117+
- uses: actions/checkout@v1
118+
- name: Install Nextflow
119+
run: |
120+
wget -qO- get.nextflow.io | bash
121+
sudo mv nextflow /usr/local/bin/
122+
env:
123+
NXF_VER: '19.10.0'
124+
- name: Download and tag image
125+
run: |
126+
docker pull nfcore/sarek:dev
127+
docker tag nfcore/sarek:dev nfcore/sarek:dev
128+
- name: Run vriant calling test on specific tools
129+
run: |
130+
nextflow run . -profile test_tool,docker --verbose --tools ${{ matrix.tool }}

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
3535
- [#60](https://github.com/nf-core/sarek/pull/60) - Update documentation
3636
- [#71](https://github.com/nf-core/sarek/pull/71) - Update `README`
3737
- [#71](https://github.com/nf-core/sarek/pull/71) - Update `CHANGELOG`
38+
- [#74](https://github.com/nf-core/sarek/pull/74) - Update docs
39+
- [#74](https://github.com/nf-core/sarek/pull/74) - Improve CI tests (both Jenkins and GitHub actions tests)
40+
- [#74](https://github.com/nf-core/sarek/pull/74) - Move all ci from `ci-extra.yml` to `ci.yml`
3841

3942
### `Removed`
4043

4144
- [#46](https://github.com/nf-core/sarek/pull/46) - Remove mention of old `build.nf` script which was included in `main.nf`
45+
- [#74](https://github.com/nf-core/sarek/pull/74) - Remove `download_image.sh` and `run_tests.sh` scripts
4246

4347
### `Fixed`
4448

Jenkinsfile

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,46 @@ pipeline {
88
stages {
99
stage('Docker setup') {
1010
steps {
11-
sh "./scripts/download_image.sh -n docker -t ALL --source-version dev --target-version dev -g smallGRCh37"
11+
sh "docker pull nfcore/sarek:dev"
12+
sh "docker tag nfcore/sarek:dev nfcore/sarek:dev"
13+
sh "docker pull nfcore/sareksnpeff:dev.GRCh37"
14+
sh "docker tag nfcore/sareksnpeff:dev.GRCh37 nfcore/sareksnpeff:dev.GRCh37"
15+
sh "docker pull nfcore/sarekvep:dev.GRCh37"
16+
sh "docker tag nfcore/sarekvep:dev.GRCh37 nfcore/sarekvep:dev.GRCh37"
17+
}
18+
}
19+
stage('Annotation') {
20+
steps {
21+
sh "nextflow run . -profile test_annotation,kraken --verbose --tools snpeff,vep,merge"
1222
}
1323
}
1424
stage('Germline') {
1525
steps {
1626
sh "rm -rf data/"
1727
sh "git clone --single-branch --branch sarek https://github.com/nf-core/test-datasets.git data"
18-
sh "./scripts/run_tests.sh --profile kraken --test GERMLINE --no-reports"
28+
sh "nextflow run . -profile test,kraken --input data/testdata/tiny/normal"
29+
sh "nextflow run . -profile test,kraken --input=false --step recalibrate -resume"
30+
sh "nextflow run . -profile test,kraken --input=false --step variantCalling"
1931
sh "rm -rf data/"
2032
}
2133
}
22-
stage('Somatic') {
34+
stage('Minimal') {
2335
steps {
24-
sh "./scripts/run_tests.sh --profile kraken --test SOMATIC --no-reports"
36+
sh "nextflow run . -profile test,kraken --skipQC all --verbose --genome smallerGRCh37 --no_intervals --tools Manta,mpileup,Strelka"
37+
sh "nextflow run . -profile test,kraken --skipQC all --verbose --genome smallerGRCh37 --tools Manta,mpileup,Strelka"
38+
sh "nextflow run . -profile test,kraken --skipQC all --verbose --genome minimalGRCh37 --no_intervals --tools Manta,mpileup,Strelka"
39+
sh "nextflow run . -profile test,kraken --skipQC all --verbose --genome minimalGRCh37 --tools Manta,mpileup,Strelka"
2540
}
2641
}
27-
stage('Targeted') {
28-
steps {
29-
sh "./scripts/run_tests.sh --profile kraken --test TARGETED --no-reports"
30-
}
31-
}
32-
stage('Annotation') {
42+
stage('Profile') {
3343
steps {
34-
sh "./scripts/run_tests.sh --profile kraken --test ANNOTATEBOTH --no-reports"
44+
sh "nextflow run . -profile test_splitfastq,kraken --verbose"
45+
sh "nextflow run . -profile test_targeted,kraken --verbose"
3546
}
3647
}
37-
stage('Multiple') {
48+
stage('Tools') {
3849
steps {
39-
sh "./scripts/run_tests.sh --profile kraken --test MULTIPLE"
50+
sh "nextflow run . -profile test_tool,kraken --verbose --tools Haplotypecaller,Freebayes,Manta,mpileup,Mutect2,Strelka"
4051
}
4152
}
4253
}

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
[![DOI](https://zenodo.org/badge/184289291.svg)](https://zenodo.org/badge/latestdoi/184289291)
88

99
[![GitHub Actions CI status](https://github.com/nf-core/sarek/workflows/nf-core%20CI/badge.svg)](https://github.com/nf-core/sarek/actions?query=workflow%3A%22sarek+CI%22)
10-
[![GitHub Actions extra-CI status](https://github.com/nf-core/sarek/workflows/nf-core%20extra%20CI/badge.svg)](https://github.com/nf-core/sarek/actions?query=workflow%3A%22sarek+extra+CI%22)
1110
[![GitHub Actions Linting status](https://github.com/nf-core/sarek/workflows/nf-core%20linting/badge.svg)](https://github.com/nf-core/sarek/actions?query=workflow%3A%22sarek+linting%22)
1211
[![CircleCi build status](https://img.shields.io/circleci/project/github/nf-core/sarek?logo=circleci)](https://circleci.com/gh/nf-core/sarek/)
1312

docs/annotation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ The cache will only be used when `--annotation_cache` and cache directories are
3636
Example:
3737

3838
```bash
39-
nextflow run nf-core/sarek/main.nf --tools snpEff --step annotate --sample file.vcf.gz --snpEff_cache /Path/To/snpEffCache --annotation_cache
40-
nextflow run nf-core/sarek/main.nf --tools VEP --step annotate --sample file.vcf.gz --vep_cache /Path/To/vepCache --annotation_cache
39+
nextflow run nf-core/sarek --tools snpEff --step annotate --sample file.vcf.gz --snpEff_cache /Path/To/snpEffCache --annotation_cache
40+
nextflow run nf-core/sarek --tools VEP --step annotate --sample file.vcf.gz --vep_cache /Path/To/vepCache --annotation_cache
4141
```
4242

4343
## Using VEP CADD plugin
@@ -51,7 +51,7 @@ To enable the use of the VEP CADD plugin:
5151
Example:
5252

5353
```bash
54-
nextflow run nf-core/sarek/main.nf --step annotate --tools VEP --sample file.vcf.gz --cadd_cache \
54+
nextflow run nf-core/sarek --step annotate --tools VEP --sample file.vcf.gz --cadd_cache \
5555
--cadd_InDels /PathToCADD/InDels.tsv.gz \
5656
--cadd_InDels_tbi /PathToCADD/InDels.tsv.gz.tbi \
5757
--cadd_WG_SNVs /PathToCADD/whole_genome_SNVs.tsv.gz \
@@ -76,5 +76,5 @@ To enable the use of the VEP GeneSplicer plugin:
7676
Example:
7777

7878
```bash
79-
nextflow run nf-core/sarek/main.nf --step annotate --tools VEP --sample file.vcf.gz --genesplicer
79+
nextflow run nf-core/sarek --step annotate --tools VEP --sample file.vcf.gz --genesplicer
8080
```

0 commit comments

Comments
 (0)