nf-core / nf-core/tools

CI Runs failing due to (potential) bug in utils method for fetching repo releases

Open
#3,264 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Description of the bug

The method nf_core.utils.get_repo_releases is failing tests when trying to check MultiQC branches contain main.

The root of this issue is that the API endpoint we hit returns at most 30 branches.
Branches are returned alphabetically and it seems that overnight MultiQC got new branches which have pushed main onto the second page, and we do not iterate paginated API results.

It is worth noting that the same method calls endpoints for releases and tags which may also be paginated (although with higher per-page limits) and it is unclear to me what the effects of not iterating paginated results would be downstream on that method.

Command used and terminal output

No response

System information

No response

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.

Research direction

Start with nf_core.utils.get_repo_releases and inspect how its GitHub API calls handle branches, releases, and tags. Check the existing tests for the MultiQC branch lookup and determine how paginated results affect downstream behavior. Done means the relevant API results are handled across pages and the affected tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.