Introduce the compatibility workflow (#2)

* Introduce the compatibility workflow * We don't need to do this here * It helps if this is put in the right folder * Update php-ci.yml * Also checkout * We can safely ignore this * Update phpstan.neon
FOSSBilling · Jun 13, 2023 · 4ee23fe · 4ee23fe
1 parent 2b23548
commit 4ee23fe
Show file tree

Hide file tree

Showing 15 changed files with 102 additions and 1 deletion.
diff --git a/.github/workflows/php-ci.yml b/.github/workflows/php-ci.yml
@@ -0,0 +1,76 @@
+name: Check FOSSBilling Compatibility
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  phpstan:
+    runs-on: ubuntu-latest
+
+    name: PHPStan - FOSSBilling Preview
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Checkout FOSSBilling Source Code
+        uses: actions/checkout@v3
+        with:
+          repository: "FOSSBilling/FOSSBilling"
+          path: "FOSSBilling"
+
+      - name: Install Composer Dependencies
+        uses: php-actions/composer@v6
+        with:
+          args: --working-dir=FOSSBilling
+          dev: no
+
+      - name: Run PHPStan
+        uses: php-actions/phpstan@v3
+        with:
+          php_version: latest
+          configuration: phpstan.neon
+          memory_limit: 512M
+
+  phpstan-release:
+    runs-on: ubuntu-latest
+
+    name: PHPStan - FOSSBilling Release
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Get the Latest FOSSBilling Release Tag
+        uses: oprypin/find-latest-tag@v1
+        with:
+          repository: "FOSSBilling/FOSSBilling"
+          releases-only: true
+        id: get_id
+
+      - name: Checkout The Release tag
+        uses: actions/checkout@v3
+        with:
+          repository: "FOSSBilling/FOSSBilling"
+          path: "FOSSBilling"
+          ref: ${{ steps.get_id.outputs.tag }}
+
+      - name: Install Composer Dependencies (<=0.4.x)
+        if: ${{ hashFiles('FOSSBilling/src/composer.json') }}
+        uses: php-actions/composer@v6
+        with:
+          args: --working-dir=FOSSBilling/src
+          dev: no
+
+      - name: Install Composer Dependencies (>=0.5.0)
+        if: ${{ hashFiles('FOSSBilling/composer.json') }}
+        uses: php-actions/composer@v6
+        with:
+          args: --working-dir=FOSSBilling/
+          dev: no
+
+      - name: Run PHPStan
+        uses: php-actions/phpstan@v3
+        with:
+          php_version: latest
+          configuration: phpstan.neon
+          memory_limit: 512M
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ In general, we use modules to extend the functionality of FOSSBilling.
 
 All modules can communicate with the other modules using their API endpoints.
 
-# Technical requirements about modules
+## Technical requirements about modules
 
 ## Required
 
@@ -35,8 +35,22 @@ All modules can communicate with the other modules using their API endpoints.
 
 We recommend hosting your extensions on a public [GitHub](https://github.com) repository.
 
+### Automated compatibility checking
+
+As FOSSBilling evolves and matures, its internal functionality changes, which can create compatibility issues between your module and FOSSBilling.
+To help developers catch these issues early on, we've designed a workflow that enables you to perform a PHPStan analysis of your module with both the latest FOSSBilling release and its preview builds.
+While PHPStan cannot perform live tests, it's a useful tool to verify that your module doesn't reference missing functions, use incorrect types, or have other common low-level issues.
+
+#### Setup
+
+More in-depth instructions are planned. For now, check out the required files:
+
+* [php-ci.yml](https://github.com/FOSSBilling/example-module/blob/main/.github/workflows/php-ci.yml)
+* [phpstan.neon](https://github.com/FOSSBilling/example-module/blob/main/phpstan.neon)
+
 ## Licensing
 This extension is open source software and is released under the Apache v2.0 license. See [LICENSE](LICENSE) for the full license terms.
 
 This product includes the following third party work:
 * Open Source Iconography by [Pictogrammers](https://pictogrammers.com/) licensed under the [Pictogrammers Free License](https://pictogrammers.com/docs/general/license/).
+* We recommend hosting your extensions on a public [GitHub](https://github.com) repository.
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,11 @@
+parameters:
+	level: 1
+	paths:
+		- src
+		- FOSSBilling
+	excludePaths:
+		analyse:
+		- src/vendor
+		- FOSSBilling
+	ignoreErrors:
+		- '#^Function __trans not found\.$#'
diff --git a/Api/Admin.php → src/Api/Admin.php b/Api/Admin.php → src/Api/Admin.php
diff --git a/Api/Client.php → src/Api/Client.php b/Api/Client.php → src/Api/Client.php
diff --git a/Api/Guest.php → src/Api/Guest.php b/Api/Guest.php → src/Api/Guest.php
diff --git a/Controller/Admin.php → src/Controller/Admin.php b/Controller/Admin.php → src/Controller/Admin.php
diff --git a/Controller/Client.php → src/Controller/Client.php b/Controller/Client.php → src/Controller/Client.php
diff --git a/Service.php → src/Service.php b/Service.php → src/Service.php
diff --git a/html_admin/mod_example_index.html.twig → src/html_admin/mod_example_index.html.twig b/html_admin/mod_example_index.html.twig → src/html_admin/mod_example_index.html.twig
diff --git a/html_admin/mod_example_settings.html.twig → ...html_admin/mod_example_settings.html.twig b/html_admin/mod_example_settings.html.twig → ...html_admin/mod_example_settings.html.twig
diff --git a/html_client/mod_example_index.html.twig → src/html_client/mod_example_index.html.twig b/html_client/mod_example_index.html.twig → src/html_client/mod_example_index.html.twig
diff --git a/html_email/mod_example_email.html.twig → src/html_email/mod_example_email.html.twig b/html_email/mod_example_email.html.twig → src/html_email/mod_example_email.html.twig
diff --git a/icon.svg → src/icon.svg b/icon.svg → src/icon.svg
diff --git a/manifest.json → src/manifest.json b/manifest.json → src/manifest.json