https://github.com/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action

GitHub action to generate PHP project documentation with clean/phpdoc-md library
https://github.com/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action

documentation generator github-actions hacktoberfest php

Last synced: about 1 month ago
JSON representation

GitHub action to generate PHP project documentation with clean/phpdoc-md library

• Host: GitHub
• URL: https://github.com/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action
• Owner: impresscms-dev
• License: mit
• Created: 2022-06-17T21:44:31.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T17:07:38.000Z (3 months ago)
• Last Synced: 2024-12-02T03:03:18.102Z (about 2 months ago)
• Topics: documentation, generator, github-actions, hacktoberfest, php
• Language: Shell
• Homepage:
• Size: 117 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![License](https://img.shields.io/github/license/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action.svg)](LICENSE)

[![GitHub release](https://img.shields.io/github/release/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action.svg)](https://github.com/impresscms-dev/generate-php-project-classes-list-file-action/releases)

# Generate PHP docs with clean/phpdoc-md

GitHub action to generate PHP project documentation in [MarkDown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) format. Based on [clean/phpdoc-md](https://github.com/clean/phpdoc-md) library.

## Usage

To use this action in your project, create workflow in your project similar to this code (Note: some parts and arguments needs to be altered):

```yaml

name: Generate documentation

on:

  push:

jobs:

  get_php_classes_list:

    runs-on: ubuntu-latest

    steps:

      - name: Checkouting project code...

        uses: actions/checkout@v2

        

      - name: Install PHP

        uses: shivammathur/[email protected]

        with:

          php-version: 8.1

          extensions: curl, gd, pdo_mysql, json, mbstring, pcre, session

          ini-values: post_max_size=256M

          coverage: none

          tools: composer:v2

          

      - name: Install Composer dependencies (with dev)

        run: composer install --no-progress --prefer-dist --optimize-autoloader

          

      - name: Generating documentation...

        uses: impresscms-dev/[email protected]

        with:

          class_root_namespace: ImpressCMS\

          included_classes: ImpressCMS\**

          output_path: ./docs/

          

      - uses: actions/upload-artifact@v3

        with:

          name: my-artifact

          path: ./docs/

```

## Arguments 

This action supports such arguments (used in `with` keyword):

| Argument    | Required | Default value        | Description                       |

|-------------|----------|----------------------|-----------------------------------|

| output_path | Yes      |                      | Path where to write generated documentation |

| class_root_namespace | Yes      |                      | Root class namespace |

| included_classes | Yes      |                      | Included classes list (supports glob style wildcards syntax; each line means one rule) |

## How to contribute? 

If you want to add some functionality or fix bugs, you can fork, change and create pull request. If you not sure how this works, try [interactive GitHub tutorial](https://skills.github.com).

If you found any bug or have some questions, use [issues tab](https://github.com/impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action/issues) and write there your questions.