nf-core / nf-core/website

Add a page about procedure to follow to patch old releases

Open
#2,398 2 comments 0 reactions 1 assignee View on GitHub

@maxulysse is already working on this.

Since Mar 20, 2024.

enhancement
Dominant language
MDX
Stars
98
Forks
298
Avg merge
14h 38m
Merged PRs (30d)
38

Description

let's say you need to patch pipeline 1.0 because that's the one in prod, so you want to patch it.
I'd create a 1.0 branch based on the 1.0 release, make a PR which fix the bug, if said bug still exists in dev, make a PR to dev to fix it too.
If necessary pin nf-core tools to ensure linting works.
Merge PRs and release from the 1.0 branch with a 1.0.fix.0 tag.
If another patch need to happen on this patched release, then continue working on said 1.0 branch, and do a 1.0.fix.1 tag

I think that we should only accept bugfixes for patch releases if the bugfix also goes into dev. I think that it needs to be applied twice, no way around that. (except if the bugfix is already in dev or no longer relevant)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.