Releases: nf-core/tools
1.5 - Iron Shark
Template pipeline
- Dropped Singularity file
- Summary now logs details of the cluster profile used if from nf-core/configs
- Dockerhub is used in favor of Singularity Hub for pulling when using the Singularity profile
- Changed default container tag from latest to dev
- Brought the logo to life
- Change the default filenames for the pipeline trace files
- Remote fetch of nf-core/configs profiles fails gracefully if offline
- Remove
params.containerand just directly defineprocess.containernow - Completion email now includes MultiQC report if not too big
params.genomeis now checked if set, to ensure that it's a valid iGenomes key- Together with nf-core/configs, helper function now checks hostname and suggests a valid config profile
Tools helper code
-
New
nf-core launchcommand to interactively launch nf-core pipelines from command-line- Works with a
parameters.settings.jsonfile shipped with each pipeline - Discovers additional
paramsfrom the pipeline dynamically
- Works with a
-
Drop Python 3.4 support
-
nf-core listnow only shows a value for "is local latest version" column if there is a local copy. -
Lint markdown formatting in automated tests
- Added
markdownlint-clifor checking Markdown syntax in pipelines and tools repo
- Added
-
Syncing now reads from a
blacklist.jsonin order to exclude pipelines from being synced if necessary. -
Added nf-core tools API description to assist developers with the classes and functions available.
- Docs are automatically built by Travis CI and updated on the nf-co.re website.
-
Introduced test for filtering remote workflows by keyword.
-
Build tools python API docs
- Use Travis job for api doc generation and publish
-
nf-core bump-versionnow stops before making changes if the linting fails -
Code test coverage
- Introduced test for filtering remote workflows by keyword
-
Linting updates
- Now properly searches for conda packages in default channels
- Now correctly validates version pinning for packages from PyPI
- Updates for changes to
process.containerdefinition
Other
- Bump
condato 4.6.7 in base nf-core Dockerfile
1.4 - Tantalum Butterfly
Template pipeline
- Institutional custom config profiles moved to github
nf-core/configs- These will now be maintained centrally as opposed to being shipped with the pipelines in
conf/ - Load
base.configby default for all profiles - Removed profiles named
standardandnone - Added parameter
--igenomesIgnoresoigenomes.configis not loaded if parameter clashes are observed - Added parameter
--custom_config_versionfor custom config version control. Can use this parameter to provide commit id for reproducibility. Defaults tomaster - Deleted custom configs from template in
conf/directory i.e.uzh.config,binac.configandcfc.config
- These will now be maintained centrally as opposed to being shipped with the pipelines in
multiqc_configandoutput_mdare now put into channels instead of using the files directly (see issue #222)- Added
local.mdto cookiecutter template indocs/configuration/. This was referenced inREADME.mdbut not present. - Major overhaul of docs to add/remove parameters, unify linking of files and added description for providing custom configs where necessary
- Travis: Pull the
devtagged docker image for testing - Removed UPPMAX-specific documentation from the template.
Tools helper code
- Make Travis CI tests fail on pull requests if the
CHANGELOG.mdfile hasn't been updated - Minor bugfixing in Python code (eg. removing unused import statements)
- Made the web requests caching work on multi-user installations
- Handle exception if nextflow isn't installed
- Linting: Update for Travis: Pull the
devtagged docker image for testing
1.3 - Citreous Swordfish
Changes:
nf-core createcommand line interface updated- Interactive prompts for required arguments if not given
- New flag for workflow author
- Updated channel order for bioconda/conda-forge channels in environment.yaml
- Increased code coverage for sub command
createandlicenses - Fixed nasty dependency hell issue between
pytestandpypackage in Python 3.4.x - Introduced
.coveragercfor pytest-cov configuration, which excludes the pipeline template now from being reported - Fix 189: Check for given conda and PyPi package dependencies, if their versions exist
- Added profiles for
cfc,binac,uzhthat can be synced across pipelines- Ordering alphabetically for profiles now
- Added
pip install --upgrade pipto.travis.ymlto update pip in the Travis CI environment
nf-core/tools version 1.2
- Updated the
nf-core releasecommand- Now called
nf-core bump-versionsinstead - New flag
--nextflowto change the required nextflow version instead
- Now called
- Template updates
- Simpler installation of the
nf-corehelper tool, now directly from PyPI - Bump minimum nextflow version to
0.32.0- required for built inmanifest.nextflowVersioncheck and access toworkflow.manifestvariables from within nextflow scripts - New
withNamesyntax for configs - Travis tests fail if PRs come against the
masterbranch, slightly refactored - Improved GitHub contributing instructions and pull request / issue templates
- Simpler installation of the
- New lint tests
.travis.ymltest for PRs made against themasterbranch- Automatic
--releaseoption not used if the travis repo isnf-core/tools - Warnings if depreciated variables
params.versionandparams.nf_required_versionare found
- New
nf-core licencessubcommand to show licence for each conda package in a workflow nf-core listnow has options for sorting pipeline nicely- Latest version of conda used in nf-core base docker image
- Updated PyPI deployment to correctly parse the markdown readme (hopefully!)
- New GitHub contributing instructions and pull request template
nf-core/tools version 1.1
Very large release containing lots of work from the first nf-core hackathon, held in SciLifeLab Stockholm.
- The Cookiecutter template has been merged into tools
- The old repo above has been archived
- New pipelines are now created using the command
nf-core create - The nf-core template and associated linting are now controlled under the same version system
- Large number of template updates and associated linting changes
- New simplified cookicutter variable usage
- Refactored documentation - simplified and reduced duplication
- Better
manifestvariables instead ofparamsfor pipeline name and version - New integrated nextflow version checking
- Updated travis docker pull command to use tagging to allow release tests to pass
- Reverted Docker and Singularity syntax to use
ENVhack again
- Improved Python readme parsing for PyPI
- Updated Travis tests to check that the correct
devbranch is being targeted - New sync tool to automate pipeline updates
- Once initial merges are complete, a nf-core bot account will create PRs for future template updates
Patch release
The version 1.0 of nf-core tools cannot be installed from PyPi. This patch fixes it, by getting rid of the requirements.txt plus declaring the dependent modules in the setup.py directly.
nf-core/tools version 1.0
Initial release of the nf-core helper tools package. Currently includes four subcommands:
nf-core list: List nf-core pipelines with local infonf-core download: Download a pipeline and singularity containernf-core lint: Check pipeline against nf-core guidelinesnf-core release: Update nf-core pipeline version number