mirror of
https://github.com/MillironX/nf-core_modules.git
synced 2024-12-22 11:08:17 +00:00
build: Bump version to 21.04.0 (#481)
* build: Bump version to 21.04.0 Recent stable release https://github.com/nextflow-io/nextflow/releases/tag/v21.04.0 * Update README.md Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com>
This commit is contained in:
parent
5e86245388
commit
bdee7804ca
4 changed files with 5 additions and 25 deletions
2
.github/workflows/nf-core-linting.yml
vendored
2
.github/workflows/nf-core-linting.yml
vendored
|
@ -21,7 +21,7 @@ jobs:
|
|||
lint:
|
||||
runs-on: ubuntu-20.04
|
||||
env:
|
||||
NXF_VER: 21.03.0-edge
|
||||
NXF_VER: 21.04.0
|
||||
|
||||
name: ${{ matrix.tags }}
|
||||
needs: changes
|
||||
|
|
2
.github/workflows/pytest-workflow.yml
vendored
2
.github/workflows/pytest-workflow.yml
vendored
|
@ -25,7 +25,7 @@ jobs:
|
|||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
nxf_version: ['21.03.0-edge']
|
||||
nxf_version: ['21.04.0']
|
||||
tags: ['${{ fromJson(needs.changes.outputs.modules) }}']
|
||||
profile: ['docker', 'singularity', 'conda']
|
||||
env:
|
||||
|
|
24
README.md
24
README.md
|
@ -1,6 +1,6 @@
|
|||
# ![nf-core/modules](docs/images/nfcore-modules_logo.png)
|
||||
|
||||
[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A520.11.0--edge-23aa62.svg?labelColor=000000)](https://www.nextflow.io/)
|
||||
[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A521.04.0-23aa62.svg?labelColor=000000)](https://www.nextflow.io/)
|
||||
[![run with conda](http://img.shields.io/badge/run%20with-conda-3EB049?labelColor=000000&logo=anaconda)](https://docs.conda.io/en/latest/)
|
||||
[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&logo=docker)](https://www.docker.com/)
|
||||
[![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg?labelColor=000000)](https://sylabs.io/docs/)
|
||||
|
@ -27,7 +27,6 @@ A repository for hosting [Nextflow DSL2](https://www.nextflow.io/docs/latest/dsl
|
|||
- [Uploading to `nf-core/modules`](#uploading-to-nf-coremodules)
|
||||
- [Guidelines](#guidelines)
|
||||
- [Terminology](#terminology)
|
||||
- [Nextflow edge releases](#nextflow-edge-releases)
|
||||
- [Help](#help)
|
||||
- [Citation](#citation)
|
||||
|
||||
|
@ -167,7 +166,7 @@ If the module doesn't exist on `nf-core/modules`:
|
|||
We have implemented a number of commands in the `nf-core/tools` package to make it incredibly easy for you to create and contribute your own modules to nf-core/modules.
|
||||
|
||||
1. Install the latest version of [`nf-core/tools`](https://github.com/nf-core/tools#installation) (`>=1.13`)
|
||||
2. Install [`nextflow`](https://nf-co.re/usage/installation) (`>=20.11.0-edge`; see [Nextflow edge releases](#nextflow-edge-releases))
|
||||
2. Install [`Nextflow`](https://www.nextflow.io/docs/latest/getstarted.html#installation) (`>=21.04.0`)
|
||||
3. Install any of [`Docker`](https://docs.docker.com/engine/installation/), [`Singularity`](https://www.sylabs.io/guides/3.0/user-guide/) or [`Conda`](https://conda.io/miniconda.html)
|
||||
4. [Fork and clone this repo locally](#uploading-to-nf-coremodules)
|
||||
5. Set up git by adding a new remote of the nf-core git repo called `upstream`
|
||||
|
@ -529,25 +528,6 @@ The features offered by Nextflow DSL2 can be used in various ways depending on t
|
|||
|
||||
- *Workflow*: What DSL1 users would consider an end-to-end pipeline. For example, from one or more inputs to a series of outputs. This can either be implemented using a large monolithic script as with DSL1, or by using a combination of DSL2 individual modules and sub-workflows.
|
||||
|
||||
## Nextflow edge releases
|
||||
|
||||
Stable releases will be becoming more infrequent as Nextflow shifts its development model to becoming more dynamic via the usage of plugins. This will allow functionality to be added as an extension to the core codebase with a release cycle that could potentially be independent to that of Nextflow itself. As a result of the reduction in stable releases, some pipelines may be required to use Nextflow `edge` releases in order to be able to exploit cutting "edge" features e.g. version 3.0 of the nf-core/rnaseq pipeline requires Nextflow `>=20.11.0-edge` in order to be able to directly download Singularity containers over `http` (see [nf-core/rnaseq#496](https://github.com/nf-core/rnaseq/issues/496)).
|
||||
|
||||
There are a number of ways you can install Nextflow `edge` releases, the main difference with stable releases being that you have to `export` the version you would like to install before issuing the appropriate installation/execution commands as highlighted below.
|
||||
|
||||
- If you would like to download and install a Nextflow `edge` release from scratch with minimal fuss:
|
||||
|
||||
```bash
|
||||
export NXF_VER="20.11.0-edge"
|
||||
wget -qO- get.nextflow.io | bash
|
||||
sudo mv nextflow /usr/local/bin/
|
||||
nextflow run nf-core/rnaseq -profile test,docker -r 3.0
|
||||
```
|
||||
|
||||
> Note if you don't have `sudo` privileges required for the last command above then you can move the `nextflow` binary to somewhere else and export that directory to `$PATH` instead. One way of doing that on Linux would be to add `export PATH=$PATH:/path/to/nextflow/binary/` to your `~/.bashrc` file so that it is available every time you login to your system.
|
||||
|
||||
- Manually download and install Nextflow from the available [assets](https://github.com/nextflow-io/nextflow/releases) on Github. See [Nextflow installation docs](https://www.nextflow.io/docs/latest/getstarted.html#installation).
|
||||
|
||||
## Help
|
||||
|
||||
For further information or help, don't hesitate to get in touch on [Slack `#modules` channel](https://nfcore.slack.com/channels/modules) (you can join with [this invite](https://nf-co.re/join/slack)).
|
||||
|
|
|
@ -25,5 +25,5 @@ if ("$PROFILE" == "singularity") {
|
|||
includeConfig 'test_data.config'
|
||||
|
||||
manifest {
|
||||
nextflowVersion = '!>=20.11.0-edge'
|
||||
nextflowVersion = '!>=21.04.0'
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue