GitHub action to generate PHP project documentation in MarkDown format. Based on evert/phpdoc-md library.

This action is container-based and runs on official PHP Docker images. It does not require setting up PHP or Composer on the runner.

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):

name: Generate documentation

on:
  push:

jobs:
  get_php_classes_list:
    runs-on: ubuntu-latest
    steps:
      - name: Checkouting project code...
        uses: actions/checkout@v2

      - name: Generating documentation...
        uses: impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action@v2
        with:
          php_version: '7.4'
          output_path: ./docs/
          ignored_files: |
            test/
            extras/
          
      - uses: actions/upload-artifact@v3
        with:
          name: my-artifact
          path: ./docs/

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

• Docker build clones git@github.com:evert/phpdoc-md.git directly and falls back to HTTPS clone when SSH credentials are not available.
• phpDocumentor release artifacts are downloaded during action runtime and are not stored in this repository.
• Dockerfile supports selecting PHP by version: docker build --build-arg PHP_VERSION=7.4 .
• php_version input must match the container runtime version (this image version is controlled by PHP_VERSION build arg).
• Tests are JavaScript integration tests based on testcontainers-node.

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.

If you found any bug or have some questions, use issues tab and write there your questions.