nf-core / nf-core/website

Feature request: Add `contributor-graphs` plot to each pipeline page.

Open
#4,281 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

It'd be nice to use https://ewels.github.io/contributor-graphs/ to generate a report for every pipeline automatically, and show this on the pipeline pages.

A few ways to do this, the one that strikes me as being cleanest / simplest is:

  • Create a new repo for reports
  • Have a GitHub Actions workflow that runs on cron and generates reports for every pipeline
  • Commit the generated reports as HTML and SVG to that repo
  • Set up a GitHub Pages website on that repo to host the HTML reports
  • nf-core website pages embed the static HTML
  • Make the SVGs + button link to the HTML report on GitHub Pages

This approach means no interactive plot within the nf-core website directly, but keeps the website lean and lightweight.

Other options:

  1. Similar to above, but use an iframe and embed the HTML report
  2. Build a javascript library and data export into contributor-graphs and render in-page directly
  3. ..something else I haven't thought of

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

No repository file or test is named. Start by reading the existing pipeline-page implementation and the contributor-graphs documentation, then confirm which hosting and integration approach maintainers want; done means every pipeline page exposes an automatically generated report.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.