Skip to content

Commit

Permalink
Merge pull request #122 from Plant-Food-Research-Open/rc/2.1.0
Browse files Browse the repository at this point in the history
Release candidate for 2.1.0
  • Loading branch information
GallVp authored Aug 2, 2024
2 parents de3e6dc + 2243767 commit 8b437a8
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 3 deletions.
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ jobs:
- minimal
- invalid
- stub
- noltr
include:
- OPTION_STUB: ""
- OPTION_STUB: "-stub"
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## v2.1.0+dev - [31-July-2024]
## v2.1.0 - [31-July-2024]

### `Added`

Expand Down
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ authors:
- family-names: "Deng"
given-names: "Cecilia"
title: "AssemblyQC: A Nextflow pipeline for reproducible reporting of assembly quality"
version: 2.1.0+dev
version: 2.1.0
date-released: 2024-07-30
url: "https://github.com/Plant-Food-Research-Open/assemblyqc"
doi: 10.1093/bioinformatics/btae477
2 changes: 1 addition & 1 deletion nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ manifest {
description = """A Nextflow pipeline which evaluates assembly quality with multiple QC tools and presents the results in a unified html report."""
mainScript = 'main.nf'
nextflowVersion = '!>=23.04.0'
version = '2.1.0+dev'
version = '2.1.0'
doi = 'https://doi.org/10.1093/bioinformatics/btae477'
}

Expand Down
27 changes: 27 additions & 0 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# **plant-food-research-open/assemblyqc** Tests

## Minimal Testing

If [Nextflow](https://www.nextflow.io/docs/latest/install.html#install-nextflow) and [Docker](https://docs.docker.com/install) are installed on the system, the pipeline can be minimally tested with the following command:

```bash
nextflow run plant-food-research-open/assemblyqc -r main -profile docker,test --outdir results
```

Or using [singularity](https://docs.sylabs.io/guides/3.0/user-guide/installation.html):

```bash
nextflow run plant-food-research-open/assemblyqc -r main -profile singularity,test --outdir results
```

## Local Testing

The test sets included in this directory can be executed by first downloading the pipeline from GitHub and then executing the following command:

```bash
./main.nf -profile docker -params-file tests/minimal/params.json --outdir results
```

## Continuous Integration (CI)

The GitHub [CI action](../.github/workflows/ci.yml) included with the pipeline continuously tests the pipeline with the various test sets listed in this directory.

0 comments on commit 8b437a8

Please sign in to comment.