feat: add manifest.version entry & read from VERSION file (#213)

* feat: add manifest.version entry & read from VERSION file * chore: update CHANGELOG.md
CCBR · Nov 25, 2024 · d116319 · d116319
1 parent 9f3722e
commit d116319
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,7 @@
 ## CHAMPAGNE development version
 
+- The CHAMPAGNE nextflow workflow now has a version entry in `nextflow.config`, in compliance with nf-core. (#213, @kelly-sovacool)
+
 ## CHAMPAGNE 0.4.0
 
 ### New features

diff --git a/main.nf b/main.nf
@@ -1,5 +1,5 @@
 log.info """\
-         CHAMPAGNE 🍾
+         CHAMPAGNE $workflow.manifest.version 🍾
          =============
          NF version   : $nextflow.version
          runName      : $workflow.runName
@@ -48,6 +48,10 @@ workflow.onComplete {
     }
 }
 
+workflow version {
+    println "CHAMPAGNE ${workflow.manifest.version}"
+}
+
 workflow DOWNLOAD_SRA {
     ch_sra = Channel.from(file(params.sra_csv)) // assets/test_human_metadata.csv
         .splitCsv ( header:true, sep:',' )

diff --git a/nextflow.config b/nextflow.config
@@ -163,13 +163,16 @@ report {
 
 includeConfig 'conf/modules.config'
 
+String pipeline_version = new File("${projectDir}/VERSION").text
+
 manifest {
     name = "CCBR/CHAMPAGNE"
     author = "CCR Collaborative Bioinformatics Resource"
     homePage = "https://github.com/CCBR/CHAMPAGNE"
     description = "CHromAtin iMmuno PrecipitAtion sequencinG aNalysis pipEline"
     mainScript = "main.nf"
     defaultBranch = "main"
+    version = "${pipeline_version}"
 }
 
 // Function to ensure that resource requirements don't go beyond