Skip to content
This repository was archived by the owner on Apr 2, 2025. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
**/var/*
**/var/*
.idea
7 changes: 4 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
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
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"]
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```