flomicsbiotech/markdown_pkgs

markdown_pkgs 镜像文档

镜像概述和主要用途

markdown_pkgs是一个专为流水线环境设计的Docker镜像，包含生成markdown报告所需的全部软件包。该镜像提供标准化的运行环境，确保在各类流水线中能够可靠、一致地生成markdown格式报告，简化依赖管理流程。

核心功能和特性

• 完整依赖集成：预装流水线中markdown报告生成所需的所有软件包
• 环境一致性：消除因依赖版本差异导致的报告生成问题
• 即开即用：无需在流水线步骤中单独配置或安装依赖
• 轻量设计：优化镜像体积，适合在CI/CD环境中快速部署

使用场景和适用范围

• CI/CD流水线中自动化生成markdown格式报告
• 需要跨环境保持报告生成一致性的项目
• 团队协作中统一markdown报告工具链的场景
• 文档自动化生成流程的标准化部署

使用方法和配置说明

基本使用

拉取镜像后，可直接运行容器执行markdown报告生成任务：

bash
docker run --rm docker.xuanyuan.run/markdown_pkgs [markdown报告生成命令]

在CI/CD流水线中集成

在流水线配置文件中指定该镜像作为运行环境，例如：

GitLab CI配置示例：

yaml
generate_markdown_report:
  stage: report
  image: docker.xuanyuan.run/markdown_pkgs
  script:
    - python generate_report.py  # 执行报告生成脚本
  artifacts:
    paths:
      - report.md  # 保存生成的markdown报告

Jenkins Pipeline配置示例：

groovy
stage('Generate Markdown Report') {
  agent {
    docker {
      image 'markdown_pkgs'
      reuseNode true
    }
  }
  steps {
    sh 'Rscript render_report.R'  # 执行R语言报告渲染脚本
  }
  post {
    always {
      archiveArtifacts artifacts: 'report.md', fingerprint: true
    }
  }
}

自定义扩展

如需添加额外依赖，可基于此镜像构建自定义镜像：

dockerfile
FROM markdown_pkgs
# 安装额外的Python包示例
RUN pip install pandas matplotlib
# 安装额外的系统依赖示例
RUN apt-get update && apt-get install -y graphviz