botsudo/action-doctum

镜像概述

该Docker镜像是一个GitHub Action，用于在GitHub Actions工作流中运行Doctum工具，实现PHP文档的解析、渲染和更新。Doctum是一个用于生成PHP项目API文档的工具。镜像提供5.x、dev、latest等多个系列版本，可在Docker Hub获取（botsudo/action-doctum）。

核心功能与特性

• 支持Doctum的三种主要操作方法：解析（parse）、渲染（render）和更新（update）
• 提供多系列版本支持：5.x稳定版、dev开发版和latest最新版
• 可通过CLI参数灵活配置Doctum运行选项
• 支持零配置快速设置，适用于简单项目的文档检查
• 与GitHub Actions无缝集成，可直接在工作流中使用

使用场景

• 在GitHub Actions工作流中自动生成PHP项目的API文档
• 对PHP代码中的文档注释进行解析和检查（lint）
• 定期更新项目文档并部署到静态站点
• 集成到CI/CD流程中，确保文档与代码同步更新

使用方法与配置说明

前提条件

• 已在GitHub仓库中配置GitHub Actions工作流
• 项目中存在Doctum配置文件（如doctum.php）或可通过命令生成

配置参数

使用示例

5.x系列示例

yml
  - uses: actions/checkout@v4
  - name: build doctum docs
    uses: sudo-bot/action-doctum@v5
    with:
        config-file: doctum.php
        method: "update"
        cli-args: "--output-format=github --no-ansi --no-progress -v"

latest系列示例

yml
  - uses: actions/checkout@v4
  - name: build doctum docs
    uses: sudo-bot/action-doctum@latest
    with:
        config-file: doctum.php
        method: "update"
        cli-args: "--output-format=github --no-ansi --no-progress -v"

dev系列示例

yml
  - uses: actions/checkout@v4
  - name: build doctum docs
    uses: sudo-bot/action-doctum@dev
    with:
        config-file: doctum.php
        method: "update"
        cli-args: "--output-format=github --no-ansi --no-progress -v"

零配置解析/检查PHP文档示例

yml
name: Lint phpdocs

on: [push]

jobs:
  lint-phpdoc:
    name: lint-phpdoc
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Create a config file
        # 扫描所有src文件夹
        run: echo "<?php return new Doctum\Doctum('src/');" > doctum-config.php
      - name: lint doctum docs
        uses: sudo-bot/action-doctum@v5
        with:
          config-file: doctum-config.php
          method: "parse"
          cli-args: "--output-format=github --no-ansi --no-progress -v"