CDPHE-bioinformatics / CDPHE-SARS-CoV-2

Workflows and scripts for the assembly and analysis of SARS-CoV-2 whole genome tiled amplicon sequencing.
https://cdphe-bioinformatics.github.io/CDPHE-SARS-CoV-2/
GNU General Public License v3.0
5 stars 0 forks source link

[REQUEST] Auto version workflow using GitHub Action #42

Open danpolanco opened 19 hours ago

danpolanco commented 19 hours ago

Feature Request

It is troublesome and error prone to manually update the workflow version.

Solution

Use a GitHub Action to automatically update the version (including the git tag) when a pull request is merged into main.

Upstream effects

None.

Downstream effects

None.

danpolanco commented 19 hours ago

We should consider using decimals instead of dashes for SemVer compatibility.

https://github.com/CDPHE-bioinformatics/CDPHE-SARS-CoV-2/blob/0fcde79e69755dcf0ab5b6e7115638c613276859/tasks/version_capture_task.wdl#L24

We have discussed using "v" but we might want to revisit this. Originally we said that with or without "v" is less important a decision than just being consistent.

After looking at more tutorials about Python, it seems better to leave the "v" off and add it where needed / prior to exporting. But more opinions required.

danpolanco commented 19 hours ago

Perhaps we remove the timezone input since the default for a container such as ubuntu:focal is UTC, which is what we assume for all of our Cloud processes as well.

https://github.com/CDPHE-bioinformatics/CDPHE-SARS-CoV-2/blob/0fcde79e69755dcf0ab5b6e7115638c613276859/tasks/version_capture_task.wdl#L17

danpolanco commented 19 hours ago

Instead of echoing the workflow version, we can directly input it into the output. I'm not sure of the benefit of echoing it, so I'm not changing this for now.

https://github.com/CDPHE-bioinformatics/CDPHE-SARS-CoV-2/blob/0fcde79e69755dcf0ab5b6e7115638c613276859/tasks/version_capture_task.wdl#L22-L33

As an example, instead we would remove the echo statement and the output would have:

String workflow_version = "2.3.1"