MNT Use gha-dispatch-ci (#32)

* ENH Update deprecation messages

* API Update deprecations

.github/workflows/ci.yml

@@ -0,0 +1,11 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  ci:
+    name: CI
+    uses: silverstripe/gha-ci/.github/workflows/ci.yml@v1

.github/workflows/dispatch-ci.yml

@@ -0,0 +1,16 @@
+name: Dispatch CI
+
+on:
+  # At 12:00 PM UTC, only on Friday and Saturday
+  schedule:
+    - cron: '0 12 * * 5,6'
+
+jobs:
+  dispatch-ci:
+    name: Dispatch CI
+    # Only run cron on the silverstripe account
+    if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dispatch CI
+        uses: silverstripe/gha-dispatch-ci@v1

.github/workflows/keepalive.yml

@@ -0,0 +1,17 @@
+name: Keepalive
+
+on:
+  workflow_dispatch:
+  # The 4th of every month at 10:50am UTC
+  schedule:
+    - cron: '50 10 4 * *'
+
+jobs:
+  keepalive:
+    name: Keepalive
+    # Only run cron on the silverstripe account
+    if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Keepalive
+        uses: silverstripe/gha-keepalive@v1

README.md

@@ -1,4 +1,7 @@
-# SilverStripe recipe-plugin
+# Silverstripe recipe-plugin
+
+[![CI](https://github.com/silverstripe/recipe-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/recipe-plugin/actions/workflows/ci.yml)
+[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
 
 ## Introduction
 

composer.json

@@ -25,7 +25,8 @@
         "composer-plugin-api": "^1.1 || ^2"
     },
     "require-dev": {
-        "composer/composer": "^1.2 || 2"
+        "composer/composer": "^1.2 || 2",
+        "squizlabs/php_codesniffer": "^3.5"
     },
     "minimum-stability": "dev"
 }

phpcs.xml.dist

@@ -1,2 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<ruleset><rule ref="PSR2" /></ruleset>
+<ruleset name="SilverStripe">
+    <description>CodeSniffer ruleset for SilverStripe coding conventions.</description>
+
+    <file>src</file>
+
+    <!-- base rules are PSR-12 -->
+    <rule ref="PSR12" >
+        <exclude name="PSR1.Methods.CamelCapsMethodName.NotCamelCaps" />
+		<exclude name="PSR1.Files.SideEffects.FoundWithSymbols" />
+    </rule>
+</ruleset>

src/RecipeInstaller.php

@@ -110,7 +110,8 @@ class RecipeInstaller extends LibraryInstaller
                     "  - Skipping <info>$relativePath</info> (<comment>existing and modified in project</comment>)"
                 );
             }
-        } elseif (in_array($relativePath, $installedFiles ?? []) ||
+        } elseif (
+            in_array($relativePath, $installedFiles ?? []) ||
             in_array($relativeDestination, $installedFiles ?? [])
         ) {
             // Don't re-install previously installed files that have been deleted
@@ -140,7 +141,7 @@ class RecipeInstaller extends LibraryInstaller
         foreach ($patterns as $pattern) {
             $expressions[] = $this->globToRegexp($pattern);
         }
-        $regExp = '#^' . $this->globToRegexp($sourceRoot . '/').'(('.implode(')|(', $expressions).'))$#';
+        $regExp = '#^' . $this->globToRegexp($sourceRoot . '/') . '((' . implode(')|(', $expressions) . '))$#';
 
         // Build directory iterator
         $directoryIterator = new RecursiveDirectoryIterator(
@@ -224,8 +225,9 @@ class RecipeInstaller extends LibraryInstaller
      * Perform any file rewrites necessary to a relative path of a file being installed.
      * E.g. if 'mysite' folder exists, rewrite 'mysite' to 'app' and 'mysite/code' to 'app/src'
      *
-     * @deprecated 1.2..2.0 Will be removed in 2.0; app folder will be hard coded and no
-     * rewrites supported.
+     * This will be removed in 2.0 as the app folder will be hard coded and no rewrites supported.
+     *
+     * @deprecated 1.2.0 Will be removed without equivalent functionality to replace it
      * @param string $destinationRoot Project root
      * @param string $relativePath Relative path to the resource being installed
      * @return string Relative path we should write to

src/RecipePlugin.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace SilverStripe\RecipePlugin;
 
 use Composer\Composer;
@@ -27,37 +26,37 @@ class RecipePlugin implements PluginInterface, EventSubscriberInterface, Capable
     /**
      * Type of recipe to check for
      */
-    const RECIPE_TYPE = 'silverstripe-recipe';
+    public const RECIPE_TYPE = 'silverstripe-recipe';
 
     /**
      * 'extra' key for project files
      */
-    const PROJECT_FILES = 'project-files';
+    public const PROJECT_FILES = 'project-files';
 
     /**
      * 'extra' key for public files
      */
-    const PUBLIC_FILES = 'public-files';
+    public const PUBLIC_FILES = 'public-files';
 
     /**
      * Hard-coded 'public' web-root folder
      */
-    const PUBLIC_PATH = 'public';
+    public const PUBLIC_PATH = 'public';
 
     /**
      * 'extra' key for list of project files installed
      */
-    const PROJECT_FILES_INSTALLED = 'project-files-installed';
+    public const PROJECT_FILES_INSTALLED = 'project-files-installed';
 
     /**
      * 'extra' key for list of public files installed
      */
-    const PUBLIC_FILES_INSTALLED = 'public-files-installed';
+    public const PUBLIC_FILES_INSTALLED = 'public-files-installed';
 
     /**
      * 'extra' key for project dependencies installed
      */
-    const PROJECT_DEPENDENCIES_INSTALLED = 'project-dependencies-installed';
+    public const PROJECT_DEPENDENCIES_INSTALLED = 'project-dependencies-installed';
 
     public function activate(Composer $composer, IOInterface $io)
     {