Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Matthias Hörtenhuber <mashehu@users.noreply.github.com>
  • Loading branch information
MatthiasZepper and mashehu committed May 3, 2024
1 parent 48fb676 commit 5f2f26e
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 7 deletions.
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 left-hand side 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 `-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.

## Pipeline software licences

Expand Down
2 changes: 1 addition & 1 deletion nf_core/download.py
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ def download_workflow_platform(self, location=None):
remote_url=f"https://github.com/{self.pipeline}.git",
revision=self.revision if self.revision else None,
commit=self.wf_sha.values() if bool(self.wf_sha) else None,
additional_tags=self.additional_tags if self.additional_tags else None,
additional_tags=self.additional_tags,
location=(location if location else None), # manual location is required for the tests to work
in_cache=False,
)
Expand Down
4 changes: 2 additions & 2 deletions nf_core/synced_repo.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,9 @@ def __init__(self, remote_url=None, branch=None, no_pull=False, hide_progress=Fa
self.remote_url = remote_url

self.repo = None
# ToDo: SyncedRepo doesn't have this method and both the ModulesRepo and
# TODO: SyncedRepo doesn't have this method and both the ModulesRepo and
# the WorkflowRepo define their own including custom init methods. This needs
# fixing, but is beyond the scope of this PR.
# fixing.
self.setup_local_repo(remote_url, branch, hide_progress)

config_fn, repo_config = load_tools_config(self.local_repo_dir)
Expand Down
3 changes: 0 additions & 3 deletions tests/test_download.py
Original file line number Diff line number Diff line change
Expand Up @@ -713,9 +713,6 @@ def test_download_workflow_for_platform_with_custom_tags(self, _, tmp_dir):
}
)

#
# Test adding a single custom tags to Seqera Platform download so CodeCov is happy.
#
@mock.patch("nf_core.download.DownloadWorkflow.get_singularity_images")
@with_temporary_folder
def test_download_workflow_for_platform_with_one_custom_tag(self, _, tmp_dir):
Expand Down

0 comments on commit 5f2f26e

Please sign in to comment.