From e0f879124d6d6a3616836746de35b99091cac0bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20K=C3=B6rner?= Date: Wed, 13 Oct 2021 10:00:36 +0200 Subject: [PATCH 1/2] updated phpDocumentor version --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 49b8ae5..3af10bb 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,5 @@ FROM php:7.4-cli -RUN curl -L https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.0.0/phpDocumentor.phar -o /usr/local/bin/phpDocumentor +RUN curl -L https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.1.2/phpDocumentor.phar -o /usr/local/bin/phpDocumentor COPY "entrypoint.sh" "/entrypoint.sh" RUN chmod +x /entrypoint.sh && chmod a+x /usr/local/bin/phpDocumentor ENTRYPOINT ["/entrypoint.sh"] From cd524657ad2cf72bbaacfb206631a79328733027 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20K=C3=B6rner?= Date: Mon, 18 Nov 2024 09:15:00 +0100 Subject: [PATCH 2/2] update phpdocumentation version, update php version, update readme --- .gitignore | 3 ++- Dockerfile | 7 ++++--- README.md | 30 +++++++++++++++++++++++++++++- 3 files changed, 35 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 17b1b2e..0b6c2c8 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -**/var/* \ No newline at end of file +**/var/* +.idea \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 3af10bb..b3889a7 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,6 @@ -FROM php:7.4-cli -RUN curl -L https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.1.2/phpDocumentor.phar -o /usr/local/bin/phpDocumentor +FROM php:8.2-cli +#RUN curl -L https://github.com/phpDocumentor/phpDocumentor/releases/latest/download/phpDocumentor.phar -o /usr/local/bin/phpDocumentor +RUN curl -L https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.5.3/phpDocumentor.phar -o /usr/local/bin/phpDocumentor COPY "entrypoint.sh" "/entrypoint.sh" RUN chmod +x /entrypoint.sh && chmod a+x /usr/local/bin/phpDocumentor -ENTRYPOINT ["/entrypoint.sh"] +ENTRYPOINT ["/entrypoint.sh"] \ No newline at end of file diff --git a/README.md b/README.md index 4022f02..a795159 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,35 @@ Create `phpdoc.dist.xml` in your root folder and use the step into your Github w ```yaml - name: PhpDocumentor - uses: gpupo/actions-phpDocumentor@1.0 + uses: koertho/actions-phpDocumentor@1 with: dir: './' ``` + +Complete example: + +```yaml +name: Documentation + +on: + workflow_dispatch: ~ + release: + types: [published, created, edited] +permissions: + contents: write +jobs: + PhpDocumentor: + runs-on: ubuntu-latest + steps: + - name: Checkout 🛎️ + uses: actions/checkout@v4 + - name: PhpDocumentor + uses: koertho/actions-phpDocumentor@1 + with: + dir: './' + - name: Deploy 🚀 + uses: JamesIves/github-pages-deploy-action@v4 + with: + branch: gh-pages + folder: build/api +```