Skip to content

Commit

Permalink
Merge pull request #1725 from ErikDanielsson/update-readme
Browse files Browse the repository at this point in the history
Add links for `nf-core modules info` and `nf-core modules patch` commands documentation in `README.md`
  • Loading branch information
ErikDanielsson authored Aug 4, 2022
2 parents 3febadb + 3a2fe99 commit bc935ba
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
- Add support for patch in `nf-core modules lint` command ([#1312](https://github.com/nf-core/tools/issues/1312))
- Add support for custom remotes in `nf-core modules lint` ([#1715](https://github.com/nf-core/tools/issues/1715))
- Make `nf-core modules` commands work with arbitrary git remotes ([#1721](https://github.com/nf-core/tools/issues/1721))
- Add links in `README.md` for `info` and `patch` commands ([#1722](https://github.com/nf-core/tools/issues/1722)])
- Fix misc. issues with `--branch` and `--base-path` ([#1726](https://github.com/nf-core/tools/issues/1726))

## [v2.4.1 - Cobolt Koala Patch](https://github.com/nf-core/tools/releases/tag/2.4) - [2022-05-16]
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@ A python package with helper tools for the nf-core community.
- [`modules list` - List available modules](#list-modules)
- [`modules list remote` - List remote modules](#list-remote-modules)
- [`modules list local` - List installed modules](#list-installed-modules)
- [`modules info` - Show information about a module](#show-information-about-a-module)
- [`modules install` - Install modules in a pipeline](#install-modules-in-a-pipeline)
- [`modules update` - Update modules in a pipeline](#update-modules-in-a-pipeline)
- [`modules remove` - Remove a module from a pipeline](#remove-a-module-from-a-pipeline)
- [`modules patch` - Create a patch file for a module](#create-a-patch-file-for-a-module)
- [`modules create` - Create a module from the template](#create-a-new-module)
- [`modules create-test-yml` - Create the `test.yml` file for a module](#create-a-module-test-config-file)
- [`modules lint` - Check a module against nf-core guidelines](#check-a-module-against-nf-core-guidelines)
Expand Down Expand Up @@ -1176,9 +1178,9 @@ INFO Removing star/align

You can pass the module name as an optional argument to `nf-core modules remove` instead of using the cli prompt, eg: `nf-core modules remove fastqc`. To specify the pipeline directory, use `--dir <pipeline_dir>`.

### Create a patch file for minor local changes in a module
### Create a patch file for a module

If you want to make a minor change to a module but still keep it up date with the remote version, you can create a patch file using `nf-core modules patch`.
If you want to make a minor change to a locally installed module but still keep it up date with the remote version, you can create a patch file using `nf-core modules patch`.

```console
$ nf-core modules patch
Expand Down Expand Up @@ -1219,7 +1221,7 @@ The generated patches work with `nf-core modules update`: when you install a new
the patch automatically. The patch application fails if the new version of the module modifies the same lines as the patch. In this case,
the patch new version is installed but the old patch file is preversed.

When linting a patched module, the patch is applied in reverse to recover the original files and then the module is linted as usual.
When linting a patched module, the linting command will check the validity of the patch. When running other lint tests the patch is applied in reverse, and the original files are linted.

### Create a new module

Expand Down

0 comments on commit bc935ba

Please sign in to comment.