Skip to content

Commit

Permalink
Update --additional-tag to --tag.
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthiasZepper committed May 3, 2024
1 parent 5f2f26e commit 4b0fe7b
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

- Replace `--tower` with `--platform`. The former will remain for backwards compatability for now but will be removed in a future release. ([#2853](https://github.com/nf-core/tools/pull/2853))
- Better error message when GITHUB_TOKEN exists but is wrong/outdated
- New `-a` / `--additional-tag` argument to add custom tags during a pipeline download ([#2938](https://github.com/nf-core/tools/pull/2938))
- New `--tag` argument to add custom tags during a pipeline download ([#2938](https://github.com/nf-core/tools/pull/2938))

### Components

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,7 @@ Subsequently, the `*.git` folder can be moved to it's final destination and link
> [!TIP]
> Also without access to Seqera Platform, pipelines downloaded with the `--platform` flag can be run if the _absolute_ path is specified: `nextflow run -r 2.5 file:/path/to/pipelinedownload.git`. Downloads in this format allow you to include multiple revisions of a pipeline in a single file, but require that the revision (e.g. `-r 2.5`) is always explicitly specified.
Facilities and those who are setting up pipelines for others to use may find the `-a` / `--additional-tag` argument helpful. It must be followed by a string in a `key=value` format and can be provided multiple times. The `key` must refer to a valid branch, tag or commit SHA. The right-hand side must comply with the naming conventions for Git tags and may not yet exist in the repository. The `-a` / `--additional-tag` argument allows customizing the downloaded pipeline with additional tags that can be used to select particular revisions in the Seqera Platform interface. For example, an accredited facility may opt to tag particular revisions according to their structured release management process: `-a "3.12.0=testing" -a "3.9.0=validated"` so their staff can easily ensure that the correct version of the pipeline is run in production.
Facilities and those who are setting up pipelines for others to use may find the `--tag` argument helpful. It must be followed by a string in a `key=value` format and can be provided multiple times. The `key` must refer to a valid branch, tag or commit SHA. The right-hand side must comply with the naming conventions for Git tags and may not yet exist in the repository. The `--tag` argument allows customizing the downloaded pipeline with additional tags that can be used to select particular revisions in the Seqera Platform interface. For example, an accredited facility may opt to tag particular revisions according to their structured release management process: `--tag "3.12.0=testing" --tag "3.9.0=validated"` so their staff can easily ensure that the correct version of the pipeline is run in production.

## Pipeline software licences

Expand Down
3 changes: 1 addition & 2 deletions nf_core/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -389,8 +389,7 @@ def create_params_file(pipeline, revision, output, force, show_hidden):
help="Include configuration profiles in download. Not available with `--platform`",
)
@click.option(
"-a",
"--additional-tags",
"--tags",
multiple=True,
help="Add custom alias tags to `--platform` downloads. For example, '-a \"3.10=validated\"' adds the custom 'validated' tag to the 3.10 release.",
)
Expand Down
4 changes: 1 addition & 3 deletions nf_core/download.py
Original file line number Diff line number Diff line change
Expand Up @@ -1746,9 +1746,7 @@ def __add_additional_tags(self) -> None:
f"[red]Adding the additional tag '{tag}' to '{anchor}' failed.[/]\n Mind that '{anchor}' must be a valid git reference that resolves to a commit, while '{tag}' must not exist hitherto."
)
else:
log.error(
f"[red]Could not apply invalid '-a' / '--additional-tag' specification[/]: '{additional_tag}'"
)
log.error(f"[red]Could not apply invalid '--tag' specification[/]: '{additional_tag}'")

def bare_clone(self, destination):
if self.repo:
Expand Down

0 comments on commit 4b0fe7b

Please sign in to comment.