{"id":25905491,"url":"https://github.com/stevekm/dumpsoftwareversions","last_synced_at":"2026-05-16T17:40:40.421Z","repository":{"id":318665191,"uuid":"702776361","full_name":"stevekm/dumpSoftwareVersions","owner":"stevekm","description":"Create MultiQC Software Versions YAML from Nextflow pipeline output","archived":false,"fork":false,"pushed_at":"2023-10-11T18:40:40.000Z","size":13,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-08T14:56:59.942Z","etag":null,"topics":["html","multiqc","nextflow","yaml"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stevekm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-10-10T01:58:24.000Z","updated_at":"2025-09-12T20:29:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"07fbb2d1-aafd-495b-9785-7ba7edbe3fa6","html_url":"https://github.com/stevekm/dumpSoftwareVersions","commit_stats":null,"previous_names":["stevekm/dumpsoftwareversions"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/stevekm/dumpSoftwareVersions","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stevekm%2FdumpSoftwareVersions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stevekm%2FdumpSoftwareVersions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stevekm%2FdumpSoftwareVersions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stevekm%2FdumpSoftwareVersions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stevekm","download_url":"https://codeload.github.com/stevekm/dumpSoftwareVersions/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stevekm%2FdumpSoftwareVersions/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33112495,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T04:41:52.686Z","status":"ssl_error","status_checked_at":"2026-05-16T04:41:52.009Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["html","multiqc","nextflow","yaml"],"created_at":"2025-03-03T05:15:17.011Z","updated_at":"2026-05-16T17:40:40.402Z","avatar_url":"https://github.com/stevekm.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dumpSoftwareVersions\n\nTiny simple command line utility used to create a software versions YAML file from the various tools used throughout a [Nextflow](https://www.nextflow.io/) pipeline, in order to generate the Software Versions HTML table input used with [MultiQC](https://multiqc.info/) reports.\n\n# Usage\n\nExample usage:\n\n```bash\n$ ./dumpSoftwareVersions -manifestName dump-software-version-demo -manifestVersion 1.0 -nxfVersion 23.04.1 -processLabel CUSTOM_DUMPSOFTWAREVERSIONS example/collated_versions.yml\n```\n\nOutput YAML is printed to stdout by default. You will want to pipe it to a file named `software_versions_mqc.yml` for use with MultiQC.\n\n- example input file: `example/collated_versions.yml`\n- example output: `example/software_versions_mqc.yml`\n\n## With Nextflow + MultiQC\n\nYou can see an example of how to use this utility inside your Nextflow pipeline [here](https://github.com/stevekm/nextflow-demos/blob/master/dumpsoftwareversions/modules/local/steve-dumpSoftwareVersions.nf).\n\nA simple example [Nextflow process](https://www.nextflow.io/docs/latest/process.html) might look like this\n\n```groovy\nprocess DUMPSOFTWAREVERSIONS {\n    container \"stevekm/dump-software-versions:0.1\"\n\n    input:\n    path(versionsYAMLFile) // single file with collated version YAML from all previous tools in the pipeline\n\n    output:\n    path(output_filename), emit: mqc_yml\n\n    script:\n    output_filename = \"software_versions_mqc.yml\"\n    \"\"\"\n    dumpSoftwareVersions \\\n    -manifestName \"${workflow.manifest.name}\" \\\n    -manifestVersion \"${workflow.manifest.version}\" \\\n    -nxfVersion \"${workflow.nextflow.version}\" \\\n    -processLabel \"${task.process}\" \\\n    \"${versionsYAMLFile}\" \u003e \"${output_filename}\"\n    \"\"\"\n}\n```\n\nThe output file here `software_versions_mqc.yml` can then be passed as an input item to your [MultiQC Nextflow process](https://github.com/stevekm/nextflow-demos/blob/master/dumpsoftwareversions/modules/nf-core/multiqc/main.nf).\n\nOnce incorporated into MultiQC, you should get a nice table that looks something like this;\n\n\u003cimg width=\"1024\" alt=\"Screenshot\" src=\"https://github.com/stevekm/dumpSoftwareVersions/assets/10505524/569b0115-c9ed-4552-801d-33de68110d79\"\u003e\n\n# Download\n\nGet it from Docker Hub here: https://hub.docker.com/repository/docker/stevekm/dump-software-versions/general\n\n```bash\ndocker pull stevekm/dump-software-versions:0.1\n```\n\n- try it out with the included Makefile recipe; `make docker-test-run`\n\nOr download binaries from a release version here: https://github.com/stevekm/dumpSoftwareVersions/releases\n\nOr build from source using Go version 1.20+;\n\n```bash\ngo build -o ./dumpSoftwareVersions ./main.go\n```\n\n# Notes\n\nSee full usage in a Nextflow pipeline here:\n\n- https://github.com/stevekm/nextflow-demos/tree/master/dumpsoftwareversions\n\nInspired by:\n\n- https://github.com/nf-core/rnaseq/blob/master/modules/nf-core/custom/dumpsoftwareversions/templates/dumpsoftwareversions.py\n\nFor use with:\n\n- https://multiqc.info/docs/reports/customisation/#listing-software-versions","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstevekm%2Fdumpsoftwareversions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstevekm%2Fdumpsoftwareversions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstevekm%2Fdumpsoftwareversions/lists"}