Skip to content

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

Description

@ewels

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions