Skip to content

Commit afcdb94

Browse files
authored
Merge pull request #3914 from nf-core/dev
2 parents caa251b + c4d2cda commit afcdb94

File tree

5 files changed

+24
-11
lines changed

5 files changed

+24
-11
lines changed

.github/workflows/sync.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ jobs:
117117
--from-branch dev \
118118
--pull-request \
119119
--username nf-core-bot \
120-
--github-repository nf-core/${{ matrix.pipeline }}
121-
--blogpost ${{inputs.blogpost}}
120+
--github-repository nf-core/${{ matrix.pipeline }} \
121+
--blog-post ${{inputs.blog_post}}
122122
123123
- name: Upload sync log file artifact
124124
if: ${{ always() }}

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# nf-core/tools: Changelog
22

3+
## [v3.5.1 - Terne Topi](https://github.com/nf-core/tools/releases/tag/3.5.1) - [2025-11-19]
4+
5+
### General
6+
7+
- Fix `blog_post` parameter for `nf-core pipelines sync` command ([#3911](https://github.com/nf-core/tools/pull/3911))
8+
- Fix markdown in sync PR message ([#3913](https://github.com/nf-core/tools/pull/3913))
9+
310
## [v3.5.0 - Terne Topi](https://github.com/nf-core/tools/releases/tag/3.5.0) - [2025-11-19]
411

512
### General

nf_core/__main__.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -612,13 +612,16 @@ def rocrate(
612612
@click.option("-g", "--github-repository", type=str, help="GitHub PR: target repository.")
613613
@click.option("-u", "--username", type=str, help="GitHub PR: auth username.")
614614
@click.option("-t", "--template-yaml", help="Pass a YAML file to customize the template")
615+
@click.option("-b", "--blog-post", type=str, help="Link to the blog post")
615616
def command_pipelines_sync(
616-
ctx, directory, from_branch, pull_request, github_repository, username, template_yaml, force_pr
617+
ctx, directory, from_branch, pull_request, github_repository, username, template_yaml, force_pr, blog_post
617618
):
618619
"""
619620
Sync a pipeline [cyan i]TEMPLATE[/] branch with the nf-core template.
620621
"""
621-
pipelines_sync(ctx, directory, from_branch, pull_request, github_repository, username, template_yaml, force_pr)
622+
pipelines_sync(
623+
ctx, directory, from_branch, pull_request, github_repository, username, template_yaml, force_pr, blog_post
624+
)
622625

623626

624627
# nf-core pipelines bump-version

nf_core/commands_pipelines.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,9 @@ def pipelines_rocrate(
306306

307307

308308
# nf-core pipelines sync
309-
def pipelines_sync(ctx, directory, from_branch, pull_request, github_repository, username, template_yaml, force_pr):
309+
def pipelines_sync(
310+
ctx, directory, from_branch, pull_request, github_repository, username, template_yaml, force_pr, blog_post
311+
):
310312
"""
311313
Sync a pipeline [cyan i]TEMPLATE[/] branch with the nf-core template.
312314
@@ -327,7 +329,7 @@ def pipelines_sync(ctx, directory, from_branch, pull_request, github_repository,
327329
is_pipeline_directory(directory)
328330
# Sync the given pipeline dir
329331
sync_obj = PipelineSync(
330-
directory, from_branch, pull_request, github_repository, username, template_yaml, force_pr
332+
directory, from_branch, pull_request, github_repository, username, template_yaml, force_pr, blog_post
331333
)
332334
sync_obj.sync()
333335
except (SyncExceptionError, PullRequestExceptionError) as e:

nf_core/pipelines/sync.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -409,20 +409,21 @@ def make_pull_request(self):
409409
log.info("Submitting a pull request via the GitHub API")
410410

411411
pr_title = f"Important! Template update for nf-core/tools v{nf_core.__version__}"
412+
blog_post_sentence = (
413+
f"For more details, check out the blog post: {self.blog_post}" if self.blog_post != "" else ""
414+
)
412415
pr_body_text = (
413416
"Version `{tag}` of [nf-core/tools](https://github.com/nf-core/tools) has just been released with updates to the nf-core template. "
414-
f"For more details, check out the blog post: {self.blog_post}\n\n"
415-
if self.blog_post != ""
416-
else ""
417+
f"{blog_post_sentence}\n\n"
417418
"Please make sure to merge this pull-request as soon as possible, "
418419
f"resolving any merge conflicts in the `{self.merge_branch}` branch (or your own fork, if you prefer). "
419420
"Once complete, make a new minor release of your pipeline.\n\n"
420421
"For instructions on how to merge this PR, please see "
421422
"[https://nf-co.re/docs/contributing/sync/](https://nf-co.re/docs/contributing/sync/#merging-automated-prs).\n\n"
422423
"For more information about this release of [nf-core/tools](https://github.com/nf-core/tools), "
423424
"please see the `v{tag}` [release page](https://github.com/nf-core/tools/releases/tag/{tag})."
424-
"> [!NOTE]\n"
425-
"> Since nf-core/tools 3.5.0, older template update PRs will not be automatically closed, but will remain open in your pipeline repository."
425+
"\n\n> [!NOTE]\n"
426+
"> Since nf-core/tools 3.5.0, older template update PRs will not be automatically closed, but will remain open in your pipeline repository. "
426427
"Older template PRs will be automatically closed once a newer template PR has been merged."
427428
).format(tag=nf_core.__version__)
428429

0 commit comments

Comments
 (0)