Feature request: Add `contributor-graphs` plot to each pipeline page.
Nobody has claimed this yet.
- 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:
- Similar to above, but use an iframe and embed the HTML report
- Build a javascript library and data export into
contributor-graphsand render in-page directly - ..something else I haven't thought of
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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