Merge branch 'master' into schema-v3

.github/workflows/ci.yml

@@ -55,8 +55,8 @@ jobs:
       - # Run AsyncAPI Validation
         name: AsyncAPI Validation
         run: |
-          docker run --rm -v $(pwd):/app asyncapi/cli:1.3.0 validate /app/var/asyncapi.yaml
-          docker run --rm -v $(pwd):/app asyncapi/cli:1.3.0 validate /app/var/asyncapi.json
+          docker run --rm -v $(pwd):/app asyncapi/cli:1.4.4 validate /app/var/asyncapi.yaml
+          docker run --rm -v $(pwd):/app asyncapi/cli:1.4.4 validate /app/var/asyncapi.json
 
       - # Upload Coverage to Coveralls
         name: Coveralls

.github/workflows/demo.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push: ~
+  pull_request: ~
+  workflow_dispatch: ~
+
+jobs:
+  demo:
+    runs-on: ubuntu-latest
+    name: CI Demo - PHP ${{ matrix.php }}
+    strategy:
+      matrix:
+        php: [8.2, 8.3]
+
+    steps:
+      - # Copies the repository files to the Action Runner
+        name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - # Installs PHP and other necessary tools
+        name: Setup PHP
+        uses: shivammathur/[email protected]
+        with:
+          php-version: ${{ matrix.php }}
+
+      - # Installs and caches PHP dependencies 
+        name: Install Dependencies
+        uses: ramsey/[email protected]
+        with:
+          working-directory: example
+
+      - # Validates composer.json structure and required fields
+        name: Validate composer.json
+        run: cd example && composer validate --ansi --strict --no-check-publish
+
+      - # Runs unit and integration tests, like phpspec, phpunit etc.
+        name: Run Tests
+        run: cd example && composer test

README.md

@@ -1,5 +1,13 @@
 # Async API Symfony Bundle
 
+The library was inspired by [nelmio/api-doc-bundle](https://github.com/nelmio/NelmioApiDocBundle); To create a code-first experience
+for PHP and Symfony engineers. This piece of software enables you to document events and messages via PHP built-in Attributes.
+
+Features
+* Code-first async messages documentation
+* Built-in ability to present code powered by [Async API React Component](https://github.com/asyncapi/asyncapi-react)
+* Automated documentation powered by PHP Reflection
+
 ## Installation
 
 ```bash

example/composer.json

@@ -5,11 +5,16 @@
     "require": {
         "php": ">=8.2",
         "ferror/asyncapi-doc-bundle": "dev-master",
-        "symfony/console": "6.3.*",
+        "symfony/console": "6.4.*",
         "symfony/flex": "^2",
-        "symfony/framework-bundle": "6.3.*",
-        "symfony/runtime": "6.3.*",
-        "symfony/yaml": "6.3.*"
+        "symfony/framework-bundle": "6.4.*",
+        "symfony/runtime": "6.4.*",
+        "symfony/yaml": "6.4.*"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^10.5",
+        "symfony/phpunit-bridge": "6.4.*",
+        "symfony/browser-kit": "6.4.*"
     },
     "config": {
         "allow-plugins": {
@@ -26,7 +31,7 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "App\\Tests\\": "tests/"
+            "App\\": "tests/"
         }
     },
     "repositories": {
@@ -50,7 +55,10 @@
     "extra": {
         "symfony": {
             "allow-contrib": false,
-            "require": "6.3.*"
+            "require": "6.4.*"
         }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit"
     }
 }