Merge pull request #1 from Edqe14/phpdocs

Phpdocs

.github/workflows/release.yaml

@@ -0,0 +1,33 @@
+name: Release
+on:
+  release:
+    types: [released]
+
+jobs:
+  phpdoc:
+    name: PHPDoc
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          tools: composer:v2
+
+      - name: Install Dependencies
+        run: composer install --no-interaction --prefer-dist --optimize-autoloader
+
+      - name: Download PHPDoc
+        run: wget https://phpdoc.org/phpDocumentor.phar
+
+      - name: Generate PHPDoc
+        run: php phpDocumentor.phar -d src -t docs
+
+      - name: Deploy PHPDoc
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: docs

.github/workflows/tests.yaml

@@ -1,5 +1,5 @@
 name: Tests
-on: ['push', 'pull_request']
+on: [pull_request]
 
 jobs:
   ci:
@@ -20,6 +20,6 @@ jobs:
         run: composer install --no-interaction --prefer-dist --optimize-autoloader
 
       - name: Tests
-        run: ./vendor/bin/pest
+        run: ./vendor/bin/pest --coverage
         env:
-          UPLOADTHING_API_KEY: ${{ secrets.UPLOADTHING_API_KEY }}
+          UPLOADTHING_API_KEY: ${{ secrets.UPLOADTHING_API_KEY }}

.gitignore

@@ -1 +1,3 @@
 /vendor/
+.phpdoc
+docs

composer.json

@@ -1,7 +1,6 @@
 {
     "name": "edqe/laravel-uploadthing",
     "description": "UploadThing Laravel driver",
-    "version": "0.0.1",
     "type": "library",
     "license": "MIT",
     "autoload": {
@@ -29,7 +28,8 @@
         }
     },
     "require": {
+        "php": ">=8.0",
         "illuminate/http": "^10.39",
         "guzzlehttp/guzzle": "^7.8"
     }
-}
+}

phpdoc.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpdocumentor
+  configVersion="3"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xmlns="https://www.phpdoc.org"
+  xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/phpDocumentor/phpDocumentor/master/data/xsd/phpdoc.xsd"
+>
+  <title>Laravel UploadThing</title>
+  <paths>
+    <output>docs</output>
+  </paths>
+  <version number="3.0.0">
+    <api>
+      <default-package-name>UploadThing</default-package-name>
+      <source dsn=".">
+        <path>src</path>
+      </source>
+    </api>
+  </version>
+</phpdocumentor>