Implement publishing workflow for standalone plugins that aren't modules

.github/workflows/deploy-standalone-plugins.yml

@@ -1,6 +1,18 @@
 name: Deploy standalone plugins to WordPress.org
 
 on:
+  # TODO The pull_request will be removed once the workflow is tested.
+  pull_request:
+    branches:
+      - trunk
+      - 'release/**'
+      - 'feature/**'
+    paths:
+      - '.github/workflows/deploy-standalone-plugins.yml'
+    types:
+      - opened
+      - reopened
+      - synchronize
   release:
     types: [published]
   workflow_dispatch:
@@ -28,6 +40,11 @@ jobs:
           cache: npm
       - name: Install npm dependencies
         run: npm ci
+      - name: Get directory
+        id: get-plugin-directory
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        run: |
+          echo "directory=$(node ./bin/plugin/cli.js get-plugin-dir --slug=${{ inputs.slug }})" >> $GITHUB_OUTPUT
       - name: Get plugin version
         id: get-version
         if: ${{ github.event_name == 'workflow_dispatch' }}
@@ -40,7 +57,7 @@ jobs:
             result=$(echo "${{ steps.get-version.outputs.version }}" | awk '/^(\*|[0-9]+(\.[0-9]+){0,2}(-[a-zA-Z0-9.]+)?)$/ {print "Matched"}')
             if [[ -n "$result" ]]; then
               # Set the manual input values in JSON format for use in the matrix.
-              echo "matrix={\"include\":[{\"slug\":\"${{ inputs.slug }}\",\"version\":\"${{ steps.get-version.outputs.version }}\",\"dry-run\":\"${{ inputs.dry-run }}\"}]}" >> $GITHUB_OUTPUT
+              echo "matrix={\"include\":[{\"slug\":\"${{ inputs.slug }}\",\"version\":\"${{ steps.get-version.outputs.version }}\",\"directory\":\"${{ steps.get-plugin-directory.outputs.directory }}\",\"dry-run\":\"true\"}]}" >> $GITHUB_OUTPUT
             else
               echo "The ${{ inputs.slug }} module slug is missing in the file plugins.json."
               exit 1
@@ -50,7 +67,7 @@ jobs:
             # for use in the matrix.
             # The "dry-run" parameter is included here to set the deployment mode.
             # When running the manual (workflow_dispatch) workflow, this value will be set from manual input type.
-            echo "matrix="$(jq -c '{include:[.modules | to_entries[] | {name:.key,slug:.value.slug,version:.value.version,"dry-run":false }]}' plugins.json) >> $GITHUB_OUTPUT
+            echo "matrix=$(jq -c '{include: ([.modules | to_entries[] | {name:.key,slug:.value.slug,version:.value.version,directory:"build","dry-run":true }] + [.plugins | to_entries[] | {name:.key,slug:.value.slug,version:.value.version,directory:"plugins","dry-run":true }])}' plugins.json)" >> $GITHUB_OUTPUT
           fi
   deploy:
     name: Deploy Plugin
@@ -69,15 +86,20 @@ jobs:
       - name: Install npm dependencies
         run: npm ci
       - name: Building standalone plugins
+        if: ${{ matrix.directory != 'plugins' }}
         run: npm run build-plugins
       - name: Deploy Standalone Plugin - ${{ matrix.slug }}
         uses: 10up/action-wordpress-plugin-deploy@stable
         with:
           dry-run: ${{ matrix.dry-run }}
         env:
-          SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
-          SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
+          # TODO Once the workflow is tested, we will remove the comment and use the secret SVN access.
+          #SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
+          #SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
+          # TODO Once the workflow is tested, we will remove this test credential.
+          SVN_PASSWORD: SVN_PASSWORD
+          SVN_USERNAME: SVN_USERNAME
           SLUG: ${{ matrix.slug }}
           VERSION: ${{ matrix.version }}
-          BUILD_DIR: ./build/${{ matrix.slug }}
-          ASSETS_DIR: ./build/${{ matrix.slug }}/.wordpress-org
+          BUILD_DIR: ./${{ matrix.directory }}/${{ matrix.slug }}
+          ASSETS_DIR: ./${{ matrix.directory }}/${{ matrix.slug }}/.wordpress-org

bin/plugin/cli.js

@@ -50,6 +50,10 @@ const {
 	handler: getPluginVersionHandler,
 	options: getPluginVersionOptions,
 } = require( './commands/get-plugin-version' );
+const {
+	handler: getPluginDirHandler,
+	options: getPluginDirOptions,
+} = require( './commands/get-plugin-dir' );
 const {
 	handler: enabledModulesHandler,
 	options: enabledModulesOptions,
@@ -102,6 +106,11 @@ withOptions(
 	.description( 'Get standalone plugin version' )
 	.action( catchException( getPluginVersionHandler ) );
 
+withOptions( program.command( 'get-plugin-dir' ), getPluginDirOptions )
+	.alias( 'get-plugin-directory' )
+	.description( 'Get plugin directory' )
+	.action( catchException( getPluginDirHandler ) );
+
 withOptions(
 	program.command( 'default-enabled-modules' ),
 	enabledModulesOptions

bin/plugin/commands/get-plugin-dir.js

@@ -0,0 +1,96 @@
+/**
+ * External dependencies
+ */
+const fs = require( 'fs' );
+const path = require( 'path' );
+
+/**
+ * Internal dependencies
+ */
+const { log } = require( '../lib/logger' );
+
+exports.options = [
+	{
+		argname: '-s, --slug <slug>',
+		description: 'Plugin or Standalone module/plugin slug to get directory',
+	},
+];
+
+/**
+ * Command to get directory for plugin/module based on the slug.
+ *
+ * @param {Object} opt Command options.
+ */
+exports.handler = async ( opt ) => {
+	doRunGetPluginDir( {
+		pluginsJsonFile: 'plugins.json', // Path to plugins.json file.
+		slug: opt.slug, // Plugin slug.
+	} );
+};
+
+/**
+ * Returns directory for plugin or module based on the slug.
+ *
+ * @param {Object} settings Plugin settings.
+ */
+function doRunGetPluginDir( settings ) {
+	if ( settings.slug === undefined ) {
+		throw Error( 'A slug must be provided via the --slug (-s) argument.' );
+	}
+
+	const pluginsFile = path.join( '.', settings.pluginsJsonFile );
+
+	// Buffer contents of plugins JSON file.
+	let pluginsFileContent = '';
+
+	try {
+		pluginsFileContent = fs.readFileSync( pluginsFile, 'utf-8' );
+	} catch ( e ) {
+		throw Error( `Error reading file at "${ pluginsFile }": ${ e }` );
+	}
+
+	// Validate that the plugins JSON file contains content before proceeding.
+	if ( ! pluginsFileContent ) {
+		throw Error(
+			`Contents of file at "${ pluginsFile }" could not be read, or are empty.`
+		);
+	}
+
+	const pluginsConfig = JSON.parse( pluginsFileContent );
+
+	// Check for valid and not empty object resulting from plugins JSON file parse.
+	if (
+		'object' !== typeof pluginsConfig ||
+		0 === Object.keys( pluginsConfig ).length
+	) {
+		throw Error(
+			`File at "${ pluginsFile }" parsed, but detected empty/non valid JSON object.`
+		);
+	}
+
+	const stPlugins = pluginsConfig.modules;
+	if ( stPlugins ) {
+		for ( const moduleDir in stPlugins ) {
+			const pluginVersion = stPlugins[ moduleDir ]?.version;
+			const pluginSlug = stPlugins[ moduleDir ]?.slug;
+			if ( pluginVersion && pluginSlug && settings.slug === pluginSlug ) {
+				return log( 'build' );
+			}
+		}
+	}
+
+	const plugins = pluginsConfig.plugins;
+	if ( plugins ) {
+		for ( const pluginDir in plugins ) {
+			const pluginVersion = plugins[ pluginDir ]?.version;
+			const pluginSlug = plugins[ pluginDir ]?.slug;
+			if ( pluginVersion && pluginSlug && settings.slug === pluginSlug ) {
+				return log( 'plugins' );
+			}
+		}
+	}
+
+	throw Error(
+		`The "${ settings.slug }" module/plugin slug is missing in the file "${ pluginsFile }".`
+	);
+}

bin/plugin/commands/get-plugin-version.js

@@ -68,22 +68,29 @@ function doRunGetPluginVersion( settings ) {
 		);
 	}
 
-	const plugins = pluginsConfig.modules;
-	if ( ! plugins ) {
-		throw Error(
-			`File at "${ pluginsFile }" parsed, but the modules are missing, or they are misspelled.`
-		);
+	const stPlugins = pluginsConfig.modules;
+	if ( stPlugins ) {
+		for ( const moduleDir in stPlugins ) {
+			const pluginVersion = stPlugins[ moduleDir ]?.version;
+			const pluginSlug = stPlugins[ moduleDir ]?.slug;
+			if ( pluginVersion && pluginSlug && settings.slug === pluginSlug ) {
+				return log( pluginVersion );
+			}
+		}
 	}
 
-	for ( const moduleDir in plugins ) {
-		const pluginVersion = plugins[ moduleDir ]?.version;
-		const pluginSlug = plugins[ moduleDir ]?.slug;
-		if ( pluginVersion && pluginSlug && settings.slug === pluginSlug ) {
-			return log( pluginVersion );
+	const plugins = pluginsConfig.plugins;
+	if ( plugins ) {
+		for ( const moduleDir in plugins ) {
+			const pluginVersion = plugins[ moduleDir ]?.version;
+			const pluginSlug = plugins[ moduleDir ]?.slug;
+			if ( pluginVersion && pluginSlug && settings.slug === pluginSlug ) {
+				return log( pluginVersion );
+			}
 		}
 	}
 
 	throw Error(
-		`The "${ settings.slug }" module slug is missing in the file "${ pluginsFile }".`
+		`The "${ settings.slug }" module/plugin slug is missing in the file "${ pluginsFile }".`
 	);
 }

bin/plugin/commands/test-plugins.js

@@ -41,6 +41,7 @@ const { log, formats } = require( '../lib/logger' );
  * @property {string} siteType              Site type. 'single' or 'multi'.
  * @property {string} pluginTestAssets      Path to 'plugin-tests' folder.
  * @property {string} builtPluginsDir       Path to 'build' directory.
+ * @property {string} pluginsDir            Path to 'plugins' directory.
  * @property {string} wpEnvFile             Path to the plugin tests specific .wp-env.json file.
  * @property {string} wpEnvDestinationFile  Path to the final base .wp-env.json file.
  * @property {string} performancePluginSlug Slug of the main WPP plugin.
@@ -71,6 +72,7 @@ exports.handler = async ( opt ) => {
 		siteType: opt.sitetype || 'single', // Site type.
 		pluginTestAssets: './plugin-tests', // plugin test assets.
 		builtPluginsDir: './build/', // Built plugins directory.
+		pluginsDir: './plugins/', // Plugins directory.
 		wpEnvFile: './plugin-tests/.wp-env.json', // Base .wp-env.json file for testing plugins.
 		wpEnvDestinationFile: './.wp-env.override.json', // Destination .wp-env.override.json file at root level.
 		wpEnvPluginsRegexPattern: '"plugins": \\[(.*)\\],', // Regex to match plugins string in .wp-env.json.
@@ -445,8 +447,8 @@ function doRunStandalonePluginTests( settings ) {
 		process.exit( 1 );
 	}
 
-	const plugins = pluginsConfig.modules;
-	if ( ! plugins ) {
+	const stPlugins = pluginsConfig.modules;
+	if ( ! stPlugins ) {
 		log(
 			formats.error(
 				'The given module configuration is invalid, the modules are missing, or they are misspelled.'
@@ -458,23 +460,67 @@ function doRunStandalonePluginTests( settings ) {
 	}
 
 	// Create an array of plugins from entries in plugins JSON file.
-	builtPlugins = Object.keys( plugins )
+	builtPlugins = Object.keys( stPlugins )
 		.filter( ( item ) => {
 			if (
 				! fs.pathExistsSync(
-					`${ settings.builtPluginsDir }${ plugins[ item ].slug }`
+					`${ settings.builtPluginsDir }${ stPlugins[ item ].slug }`
 				)
 			) {
 				log(
 					formats.error(
-						`Built plugin path "${ settings.builtPluginsDir }${ plugins[ item ].slug }" not found, skipping and removing from plugin list`
+						`Built plugin path "${ settings.builtPluginsDir }${ stPlugins[ item ].slug }" not found, skipping and removing from plugin list`
 					)
 				);
 				return false;
 			}
 			return true;
 		} )
-		.map( ( item ) => plugins[ item ].slug );
+		.map( ( item ) => stPlugins[ item ].slug );
+
+	// Append plugins into array.
+	const plugins = pluginsConfig.plugins;
+	if ( ! plugins ) {
+		log(
+			formats.error(
+				'The given plugin configuration is invalid, the plugins are missing, or they are misspelled.'
+			)
+		);
+
+		// Return with exit code 1 to trigger a failure in the test pipeline.
+		process.exit( 1 );
+	}
+
+	// Create an array of plugins from entries in plugins JSON file.
+	builtPlugins = builtPlugins.concat(
+		Object.keys( plugins )
+			.filter( ( item ) => {
+				try {
+					fs.copySync(
+						`${ settings.pluginsDir }${ plugins[ item ].slug }/`,
+						`${ settings.builtPluginsDir }${ plugins[ item ].slug }/`,
+						{
+							overwrite: true,
+						}
+					);
+					log(
+						formats.success(
+							`Copied plugin "${ plugins[ item ].slug }".\n`
+						)
+					);
+					return true;
+				} catch ( e ) {
+					// Handle the error appropriately
+					log(
+						formats.error(
+							`Error copying plugin "${ plugins[ item ].slug }": ${ e.message }`
+						)
+					);
+					return false;
+				}
+			} )
+			.map( ( item ) => plugins[ item ].slug )
+	);
 
 	// For each built plugin, copy the test assets.
 	builtPlugins.forEach( ( plugin ) => {

plugins.json

@@ -9,5 +9,10 @@
       "version": "1.0.5"
     }
   },
-  "plugins": [ "auto-sizes" ]
+  "plugins": {
+    "auto-sizes": {
+      "slug": "auto-sizes",
+      "version": "1.0.1"
+    }
+  }
 }