Merge pull request #14 from emulsify-ds/release/2.1.0

Prepare Emulsify Tools 2.1.0 release

Author: callinmullaney

.github/workflows/php-compatibility.yml

@@ -30,6 +30,25 @@ jobs:
       - name: Lint PHP sources
         run: git ls-files '*.php' | xargs -n 1 php -l
 
+  phpcs:
+    name: PHPCS (PHP 8.4)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "8.4"
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-interaction
+
+      - name: Run PHP_CodeSniffer
+        run: composer lint:phpcs
+
   unit:
     name: PHPUnit (Drupal ${{ matrix.drupal-label }} / PHP ${{ matrix.php-version }})
     runs-on: ubuntu-latest

.github/workflows/semantic-release.yml

@@ -25,6 +25,9 @@ jobs:
         uses: cycjimmy/semantic-release-action@v6
         with:
           semantic_version: 25.0.3
+          extra_plugins: |
+            @semantic-release/changelog@6.0.3
+            @semantic-release/git@10.0.1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

LICENSE

@@ -1,7 +1,7 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 2, June 1991
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
@@ -290,8 +290,8 @@ to attach them to the start of each source file to most effectively
 convey the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    {description}
-    Copyright (C) {year}  {fullname}
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -329,12 +329,11 @@ necessary.  Here is a sample; alter the names:
   Yoyodyne, Inc., hereby disclaims all copyright interest in the program
   `Gnomovision' (which makes passes at compilers) written by James Hacker.
 
-  {signature of Ty Coon}, 1 April 1989
+  <signature of Ty Coon>, 1 April 1989
   Ty Coon, President of Vice
 
 This General Public License does not permit incorporating your program into
 proprietary programs.  If your program is a subroutine library, you may
 consider it more useful to permit linking proprietary applications with the
 library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.
-

LICENSE.txt

@@ -15,22 +15,31 @@ codebase now uses PHP 8.4-only syntax where it improves readability.
 - The Twig helpers and child theme generator remain broadly useful on their own,
   but the favicon migration and admin-theme favicon features expect the
   Emulsify 7.x companion theme APIs to be present.
+- In short: child theme generation remains available for Emulsify Drupal 6.x
+  projects, while generated favicon deployment and repair are the Emulsify
+  Drupal 7.x companion workflows in this 2.x line.
 
 ## Usage
 
 ### Child theme generation
 
-Emulsify Tools 1.x provides the supported Drush workflow for generating Emulsify Drupal 6.x child themes. Use either command form:
-
-Child theme generation:
+Emulsify Tools 2.x still includes the supported Drush workflow for generating
+Emulsify Drupal 6.x child themes. Use either command form:
 
 `drush emulsify_tools:bake [theme_name]`
 
-The commands are equivalent. The generated child theme uses `emulsify` as its runtime parent theme and should be created under the Drupal custom theme path expected by the command, such as `web/themes/custom/my_theme` in a Composer-based Drupal project.
+`drush emulsify [theme_name]`
+
+The commands are equivalent. The generated child theme uses `emulsify` as its
+runtime parent theme and should be created under the Drupal custom theme path
+expected by the command, such as `web/themes/custom/my_theme` in a
+Composer-based Drupal project.
 
-Drupal core Starterkit-based generation is being prepared for the Emulsify Drupal 7.x release line. For Emulsify Drupal 6.x, use Emulsify Tools for child theme generation.
+Drupal core Starterkit-based generation is being prepared for the Emulsify Drupal
+7.x release line. For Emulsify Drupal 6.x child theme projects, use Emulsify
+Tools for child theme generation.
 
-Generated favicon deployment:
+Generated favicon deployment for Emulsify Drupal 7.x companion themes:
 
 `drush emulsify_tools:favicon-generate [theme_name]`
 
@@ -304,7 +313,12 @@ To validate the Emulsify Drupal 6.x child theme generation workflow against this
 .github/scripts/generation-smoke.sh
 ```
 
-The script creates a disposable Drupal fixture site, installs Emulsify Drupal `^6`, installs this checkout as Emulsify Tools `1.x`, verifies both Drush command help targets, runs `drush emulsify watson`, validates the generated theme files, and enables the generated child theme. It intentionally does not test Drupal core Starterkit generation.
+The script creates a disposable Drupal fixture site, installs Emulsify Drupal
+`^6`, installs this 2.x checkout through the script's local `TOOLS_VERSION`
+fixture alias, verifies both Drush command help targets, runs
+`drush emulsify watson`, validates the generated theme files, and enables the
+generated child theme. It intentionally does not test Drupal core Starterkit
+generation or the Emulsify Drupal 7.x favicon deployment workflow.
 
 Requirements: Composer and PHP. The default SQLite fixture database also requires `pdo_sqlite`.
 
@@ -343,8 +357,9 @@ There's a two-step process to publish a new release to [the project page](https:
 
 - Merge the release-ready changes into `main`.
 - The [semantic-release workflow](https://github.com/emulsify-ds/emulsify_tools/actions)
-  will calculate the next version from the merged commit messages, create the
-  GitHub release, and push the new tag to Drupal.org.
+  will calculate the next version from the merged commit messages, update
+  `CHANGELOG.md`, create a `[skip ci]` release commit, create the GitHub
+  release, and push the release commit and new tag to Drupal.org.
 - When the workflow completes, confirm the new version appears on the
   [GitHub Releases page](https://github.com/emulsify-ds/emulsify_tools/releases).
 

README.md

@@ -29,6 +29,11 @@
     "drush/drush": "Install Drush 13+ to use the emulsify_tools:bake and favicon deployment commands."
   },
   "scripts": {
+    "lint": [
+      "@lint:phpcs"
+    ],
+    "lint:phpcs": "phpcs -q",
+    "lint:phpcbf": "phpcbf",
     "test:unit": "phpunit --configuration phpunit.xml.dist",
     "test:deprecations": "phpstan analyse --configuration phpstan.neon.dist --no-progress --memory-limit=1G --debug"
   },

composer.json

@@ -1,11 +1,19 @@
 <?php
 
+/**
+ * @file
+ * Post update hooks for Emulsify Tools.
+ */
+
 declare(strict_types=1);
 
 use Drupal\emulsify_tools\Favicon\FaviconThemeSettingsBackfill;
 
 /**
  * Backfills favicon theme settings for installed Emulsify-based themes.
+ *
+ * @param array<string, mixed> $sandbox
+ *   The Drupal post update sandbox.
  */
 function emulsify_tools_post_update_backfill_emulsify_favicon_settings(array &$sandbox = []): string {
   /** @var \Drupal\emulsify_tools\Favicon\FaviconThemeSettingsBackfill $backfill */

emulsify_tools.post_update.php

@@ -1,4 +1,10 @@
 services:
+  cache.emulsify_tools:
+    class: Drupal\Core\Cache\CacheBackendInterface
+    tags:
+      - { name: cache.bin }
+    factory: ['@cache_factory', 'get']
+    arguments: [emulsify_tools]
   emulsify_tools.filesystem:
     class: Symfony\Component\Filesystem\Filesystem
   Symfony\Component\Filesystem\Filesystem:

emulsify_tools.services.yml

@@ -25,9 +25,10 @@
   "scripts": {
     "husky:commit-msg": "commitlint --edit $1",
     "husky:pre-commit": "npm run lint",
-    "lint": "npm run lint:php",
+    "lint": "npm run lint:php && npm run lint:phpcs",
     "lint-fix": "npm run lint:php",
     "lint:php": "node scripts/lint-php.mjs",
+    "lint:phpcs": "composer lint:phpcs",
     "lint-staged": "lint-staged"
   }
 }