咨询为Snakemake编写的流程添加版本号的标准/推荐方案

1. Git标签+流程内自动读取版本 #

这是最标准的版本控制方案：

• 用Git标签标记正式版本，比如执行git tag v1.2.0，推送到仓库后，用户克隆代码可通过git describe --tags快速查看当前版本。
• 在Snakefile中添加代码自动读取Git版本信息，让用户运行流程时能直观看到：

  import subprocess
  
  def get_workflow_version():
      try:
          return subprocess.check_output(
              ["git", "describe", "--tags", "--always"],
              stderr=subprocess.STDOUT,
              text=True
          ).strip()
      except (subprocess.CalledProcessError, FileNotFoundError):
          # 无Git环境时返回默认值
          return "unknown"
  
  WORKFLOW_VERSION = get_workflow_version()
  

  可以在流程的提示信息或日志中输出版本，比如：

  rule all:
      input: ...
      message: f"当前运行的流程版本: {WORKFLOW_VERSION}"
  

2. 配置文件存储版本号 #

如果不想依赖Git环境，可将版本号写入独立文件或配置文件：

• 创建version.txt，直接写入v1.2.0；或者在config.yaml中添加字段：

  workflow:
    version: v1.2.0
  

• 在Snakefile中读取这个值：

  # 读取version.txt的方式
  with open("version.txt", "r") as f:
      WORKFLOW_VERSION = f.read().strip()
  
  # 读取config.yaml的方式
  configfile: "config.yaml"
  WORKFLOW_VERSION = config["workflow"]["version"]
  

  这种方式适合离线部署场景，用户打开文件就能直接确认版本。

3. 自定义命令行参数显示版本 #

添加自定义参数，让用户可以直接查询版本：

import argparse

parser = argparse.ArgumentParser(add_help=False)
parser.add_argument("--workflow-version", action="store_true", help="显示流程版本")
args, unknown = parser.parse_known_args()

if args.workflow_version:
    print(f"流程版本: {WORKFLOW_VERSION}")
    exit(0)

用户运行snakemake --workflow-version就能快速获取版本信息。

4. 优化CHANGELOG.md的使用 #

你已有的CHANGELOG.md是很好的版本追溯工具，建议按**版本号+发布日期+变更类型（新增/修改/修复）**的格式整理，让用户能清晰看到每个版本的迭代内容。同时可在README中明确标注当前最新版本，并说明查看部署版本的方法（比如Git标签、配置文件）。

总结 #

优先推荐Git标签+流程内自动读取的组合：既利用Git的版本控制能力保证版本准确性，又能让用户在运行流程时直观看到版本；配合规范的CHANGELOG.md，可兼顾版本追溯和用户体验。

内容的提问来源于stack exchange，提问作者dariober