nf-core / nf-core/tools

Automatic listing of modules versions changed on pipeline release

Open
#1,236 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

command line tools infrastructure modules
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

The modules that are updated on pipeline release are currently manually listed on the CHANGELOG.md see here.

As discussed on this PR, it might be nice to implement an automatic listing of the module versions that have been changed on pipeline release. The idea would be, as suggested by @drpatelh, to list the container address in modules.json and try and look for a diff between releases to get an automated listing of what has changed instead of getting the info manually.

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 by reading CHANGELOG.md#software-dependencies, the modules.json format, and the discussion in PR #672. Determine how release-to-release differences should be identified and how the generated module version list should be incorporated into the changelog; done means releases no longer require this section to be assembled manually.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
release, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.