README.md

A GitHub action to run Doctum

Series	Badges
5.x
dev
latest

Go to Doctum at GitHub

You can find the image on Docker Hub

Example usage for 5.x series

  - uses: actions/checkout@v4
  - name: build doctum docs
    uses: sudo-bot/action-doctum@v5
    with:
        config-file: doctum.php
        # parse, render or update
        method: "update"
        # (optional) defaults to '--output-format=github --no-ansi --no-progress -v'
        cli-args: "--output-format=github --no-ansi --no-progress -v"

Example usage for latest series

  - uses: actions/checkout@v4
  - name: build doctum docs
    uses: sudo-bot/action-doctum@latest
    with:
        config-file: doctum.php
        # parse, render or update
        method: "update"
        # (optional) defaults to '--output-format=github --no-ansi --no-progress -v'
        cli-args: "--output-format=github --no-ansi --no-progress -v"

Example usage for dev series

  - uses: actions/checkout@v4
  - name: build doctum docs
    uses: sudo-bot/action-doctum@dev
    with:
        config-file: doctum.php
        # parse, render or update
        method: "update"
        # (optional) defaults to '--output-format=github --no-ansi --no-progress -v'
        cli-args: "--output-format=github --no-ansi --no-progress -v"

Example for a zero-config setup to parse/lint phpdocs

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
        # Scan all the src folder
        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"
          # (optional) defaults to '--output-format=github --no-ansi --no-progress -v'
          cli-args: "--output-format=github --no-ansi --no-progress -v"