Skip to content

add optional link to blogpost to sync PR #3852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mashehu merged 7 commits into from
Oct 31, 2025
Merged

add optional link to blogpost to sync PR #3852

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
034a243
add blobpost to sync
mashehu Oct 28, 2025
d7d19f6
[automated] Update CHANGELOG.md
nf-core-bot Oct 28, 2025
d2e2c13
make blogpost input required
mashehu Oct 28, 2025
1b1172c
be more specific with blog_post type checks
mashehu Oct 28, 2025
65e3bdd
Merge branch 'add-blogpost-to-sync' of github.com:mashehu/tools into …
mashehu Oct 28, 2025
b3a1569
Update .github/workflows/sync.yml
mirpedrol Oct 28, 2025
bcb61af
Merge branch 'dev' into add-blogpost-to-sync
mashehu Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/sync.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ on:
description: "Enable debug/verbose mode (true or false)"
type: boolean
default: false
blog_post:
description: "link to release blogpost"
type: string
required: true

# Cancel if a newer run is started
concurrency:
Expand Down Expand Up @@ -114,6 +118,7 @@ jobs:
--pull-request \
--username nf-core-bot \
--github-repository nf-core/${{ matrix.pipeline }}
--blogpost ${{inputs.blogpost}}

- name: Upload sync log file artifact
if: ${{ always() }}
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

### General

- add optional link to blogpost to sync PR ([#3852](https://github.com/nf-core/tools/pull/3852))

### Template

### Linting
Expand Down
6 changes: 5 additions & 1 deletion nf_core/pipelines/sync.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ def __init__(
gh_username: str | None = None,
template_yaml_path: str | None = None,
force_pr: bool = False,
blog_post: str = "",
):
"""Initialise syncing object"""

Expand All @@ -92,6 +93,7 @@ def __init__(
self.gh_username = gh_username
self.gh_repo = gh_repo
self.pr_url = ""
self.blog_post = blog_post

self.config_yml_path, self.config_yml = nf_core.utils.load_tools_config(self.pipeline_dir)
assert self.config_yml_path is not None and self.config_yml is not None # mypy
Expand Down Expand Up @@ -377,7 +379,9 @@ def make_pull_request(self):
pr_title = f"Important! Template update for nf-core/tools v{nf_core.__version__}"
pr_body_text = (
"Version `{tag}` of [nf-core/tools](https://github.com/nf-core/tools) has just been released with updates to the nf-core template. "
"This automated pull-request attempts to apply the relevant updates to this pipeline.\n\n"
f"For more details, check out the blog post: {self.blog_post}\n\n"
if self.blog_post != ""
else ""
"Please make sure to merge this pull-request as soon as possible, "
f"resolving any merge conflicts in the `{self.merge_branch}` branch (or your own fork, if you prefer). "
"Once complete, make a new minor release of your pipeline.\n\n"
Expand Down
Loading