Add plugin initialization script and workflow template

Author: N3XT0R

.github/workflows/ci.template.yml

@@ -0,0 +1,98 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: [ '*' ]
+    tags: [ '*' ]
+  pull_request:
+    branches: [ '*' ]
+
+jobs:
+  ci:
+    name: Run Quality Checks
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          tools: composer, phpunit, xdebug
+          coverage: xdebug
+
+      - name: Install Dependencies
+        run: composer install --no-progress --no-suggest --prefer-dist
+
+      - name: Run PHPUnit Tests
+        run: vendor/bin/phpunit --configuration phpunit.xml --coverage-clover=coverage/clover.xml --path-coverage
+
+      - uses: qltysh/qlty-action/coverage@v1
+        with:
+          token: ${{ secrets.QLTY_COVERAGE_TOKEN }}
+          files: coverage/clover.xml
+
+  build:
+        name: Package Plugin
+        runs-on: ubuntu-latest
+        needs: ci
+        if: github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/')
+
+        steps:
+          - name: Checkout Repository
+            uses: actions/checkout@v4
+
+          - name: Set up PHP
+            uses: shivammathur/setup-php@v2
+            with:
+              php-version: '8.2'
+
+          - name: Install Dependencies
+            run: composer install --no-dev --no-progress --prefer-dist
+
+          - name: Generate Plugin Header
+            run: composer generate-header
+
+          - name: Make build script executable
+            run: chmod +x build/build.sh
+
+          - name: Run build script
+            run: ./build/build.sh
+
+          - name: Upload Artifact
+            uses: actions/upload-artifact@v4
+            with:
+              name: xpub
+              path: build/dist
+
+  release:
+       name: Create GitHub Release
+       runs-on: ubuntu-latest
+       needs: build
+       if: startsWith(github.ref, 'refs/tags/')
+       permissions:
+         contents: write
+
+       steps:
+         - name: Download Build Artifact
+           uses: actions/download-artifact@v4
+           with:
+             name: xpub
+             path: release/
+
+         - name: Re-zip downloaded artifact for GitHub Release
+           run: |
+            cd release
+            zip -r ../xpub-multi-channel-publisher.zip .
+
+
+         - name: Create GitHub Release
+           uses: softprops/action-gh-release@v1
+           with:
+             body_path: release/xpub-multi-channel-publisher/CHANGELOG.md
+             files: xpub-multi-channel-publisher.zip
+           env:
+             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

.github/workflows/ci.yml

@@ -52,4 +52,4 @@ composer.lock
 
 # Build artifacts
 /build/dist/
-\n.phpunit.result.cache
+.phpunit.result.cache

.gitignore

@@ -0,0 +1,48 @@
+#!/usr/bin/env php
+<?php
+declare(strict_types=1);
+
+$template = __DIR__ . '/../plugin-skeleton.php.dist';
+if (!file_exists($template)) {
+    fwrite(STDERR, "Template $template not found.\n");
+    exit(1);
+}
+
+$slug = readline('Plugin slug: ');
+$slug = trim($slug);
+if ($slug === '') {
+    fwrite(STDERR, "Invalid plugin slug.\n");
+    exit(1);
+}
+
+$pluginFile = __DIR__ . '/../' . $slug . '.php';
+if (file_exists($pluginFile)) {
+    fwrite(STDERR, "File $pluginFile already exists.\n");
+    exit(1);
+}
+
+if (!copy($template, $pluginFile)) {
+    fwrite(STDERR, "Failed to create plugin file.\n");
+    exit(1);
+}
+
+echo "Created plugin file $pluginFile\n";
+
+$workflowTemplate = __DIR__ . '/../.github/workflows/ci.template.yml';
+if (file_exists($workflowTemplate)) {
+    $workflow = file_get_contents($workflowTemplate);
+    $workflow = str_replace(
+        ['xpub-multi-channel-publisher', 'xpub'],
+        [$slug, $slug],
+        $workflow
+    );
+    $workflowDir = __DIR__ . '/../.github/workflows';
+    if (!is_dir($workflowDir)) {
+        mkdir($workflowDir, 0777, true);
+    }
+    file_put_contents($workflowDir . '/ci.yml', $workflow);
+    echo "Generated workflow at .github/workflows/ci.yml\n";
+} else {
+    fwrite(STDERR, "Workflow template not found.\n");
+}
+

bin/init-plugin.php

@@ -19,6 +19,9 @@
     "generate-header": [
       "php generate-header.php"
     ],
-    "test": "vendor/bin/phpunit --configuration phpunit.xml"
+    "test": "vendor/bin/phpunit --configuration phpunit.xml",
+    "init-plugin": [
+      "php bin/init-plugin.php"
+    ]
   }
 }

composer.json

@@ -2,8 +2,14 @@
 
 declare(strict_types=1);
 
-$file = __DIR__ . '/plugin-skeleton.php';
 $composer = json_decode(file_get_contents(__DIR__ . '/composer.json'), true);
+$slug = basename($composer['name'] ?? 'plugin');
+
+// try default plugin-skeleton.php first for backwards compatibility
+$file = __DIR__ . '/plugin-skeleton.php';
+if (!file_exists($file)) {
+    $file = __DIR__ . '/' . $slug . '.php';
+}
 
 exec('git describe --tags --abbrev=0 2>/dev/null', $out, $exit);
 $version = $exit === 0 ? trim($out[0]) : '0.1.0';