Initial code

Author: MekDrop

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: monthly
+    labels:
+      - dependencies

.gitignore

@@ -0,0 +1 @@
+/.idea/

README.md

@@ -1,2 +1,63 @@
-# generate-phpdocs-with-evert-phpdoc-md-action
-GitHub action to generate PHP project documentation with evert/phpdoc-md library
+[![License](https://img.shields.io/github/license/impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action.svg)](LICENSE)
+[![GitHub release](https://img.shields.io/github/release/impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action.svg)](https://github.com/impresscms-dev/generate-php-project-classes-list-file-action/releases)
+
+# Generate PHP docs with evert/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/setup-php@master
+        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 --no-suggest --prefer-dist --optimize-autoloader       
+          
+      - name: Generating documentation...
+        uses: impresscms-dev/[email protected]
+        with:
+          output_path: ./docs/
+          ignored_files: |
+            test/
+            extras/
+          
+      - 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                       |
+|-------------|----------|----------------------|-----------------------------------|
+| ignored_files | No      |                      | Defines files that can be ignored (supports glob rules; each line means one rule) |
+| phpdocumentor_version | No | latest | What [PHP Documentator](https://www.phpdoc.org) version to use? (version = docker image tag) |
+| output_path | Yes | | Path where to write generated documentation |
+
+## 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://try.github.io).
+
+If you found any bug or have some questions, use [issues tab](https://github.com/impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action/issues) and write there your questions.

action.yml

@@ -0,0 +1,54 @@
+name: 'Generate PHP docs with evert/phpdoc-md'
+description: 'GitHub action to generate PHP project documentation in MarkDown format. Based on evert/phpdoc-md library.'
+
+branding:
+  icon: book
+  color: red
+
+inputs:
+  ignored_files:
+    description: "Defines files that can be ignored (supports glob rules; each line means one rule)"
+    required: false
+    default: ''
+  phpdocumentor_version:
+    description: "What PHP Documentator version to use? (version = docker image tag)"
+    default: latest
+    required: false
+  output_path:
+    description: "Path where to write generated documentation"
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Setting env variables...
+      run: |
+        echo "GENERATOR_TMP_FILES_PATH=${{ runner.temp }}/phpdocs-${{ github.sha }}-${{ github.run_id }}-${{ github.github.run_attempt }}" >> $GITHUB_ENV
+      shell: bash        
+  
+    - name: Creating tmp folders...
+      run: |
+        rm -rf ${{ env.GENERATOR_TMP_FILES_PATH }} || true
+        mkdir -p ${{ env.GENERATOR_TMP_FILES_PATH }}
+      shell: bash
+
+    - name: Running phpDocumentator...
+      run: bash ${{ github.action_path }}/bin/phpdoc.sh "${{ inputs.ignored_files }}" "${{ inputs.phpdocumentor_version }}"
+      shell: bash
+
+    - name: Installing evert/phpdoc-md...
+      run: composer global require 'evert/phpdoc-md=~0.2.0'
+      shell: bash
+
+    - name: Generating documentation...
+      run: composer global exec phpdocmd ${{ env.GENERATOR_TMP_FILES_PATH }}/structure.xml {{ inputs.output_path }}
+      shell: bash
+
+    - name: Uninstalling evert/phpdoc-md...
+      run: composer global remove evert/phpdoc-md
+      shell: bash
+
+    - name: Deleting tmp data...
+      run: |
+        rm -rf ${{ env.GENERATOR_TMP_FILES_PATH }} || true
+      shell: bash

bin/phpdoc.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+IGNORED_FILES=$1
+PHPDOC_TAG=$2
+
+GENERATOR_DOCKER_APP_ARGS="--target=/result --directory=/data --cache-folder=/tmp -v --template=xml --ansi --no-interaction"
+if [ "$IGNORED_FILES" != "" ]; then
+  while read -r line
+  do
+    GENERATOR_DOCKER_APP_ARGS="$GENERATOR_DOCKER_APP_ARGS --ignore=\"$line\""
+  done <<< "$IGNORED_FILES"
+fi;
+
+docker run \
+  --rm \
+  -v ${PWD}:/data \
+  -v ${GENERATOR_TMP_FILES_PATH}:/result \
+  phpdoc/phpdoc:$PHPDOC_TAG \
+  $GENERATOR_DOCKER_APP_ARGS