Merge pull request #157 from iMattPro/updates

Improve GH Actions in CLI

Author: iMattPro

.gitattributes

@@ -1,7 +1,7 @@
-/tests/			export-ignore
-.github/        export-ignore
-.gitignore		export-ignore
-.gitattributes	export-ignore
-phpunit.xml.dist	export-ignore
-composer.lock	export-ignore
-build.xml		export-ignore
+/tests           export-ignore
+/.github         export-ignore
+.gitignore       export-ignore
+.gitattributes   export-ignore
+phpunit.xml.dist export-ignore
+composer.lock    export-ignore
+build.xml        export-ignore

console/create.php

@@ -22,6 +22,7 @@
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\ChoiceQuestion;
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 use Symfony\Component\Console\Question\Question;
 
@@ -158,16 +159,31 @@ protected function get_component_data()
 		$components = $this->packager->get_component_dialog_values();
 		foreach ($components as $component => $details)
 		{
-			foreach ($details['dependencies'] as $depends)
+			// Skip early as it's handled elsewhere
+			if ($component === 'githubactions_custom')
 			{
-				if (empty($this->data['components'][$depends]))
-				{
-					$this->data['components'][$component] = false;
-					continue 2;
-				}
+				continue;
 			}
 
-			$this->data['components'][$component] = $this->get_user_input('component_' . $component, $details['default']);
+			// Check dependencies
+			if (!$this->check_dependencies($details['dependencies']))
+			{
+				$this->data['components'][$component] = false;
+				continue;
+			}
+
+			// Handle GitHub Actions
+			if ($component === 'githubactions')
+			{
+				$this->handle_github_actions();
+				continue;
+			}
+
+			// Default logic for all other components
+			$this->data['components'][$component] = $this->get_user_input(
+				'component_' . $component,
+				$details['default']
+			);
 		}
 	}
 
@@ -201,4 +217,52 @@ protected function get_user_input($value, $default)
 
 		return $return_value;
 	}
+
+	/**
+	 * Check if all dependencies are satisfied
+	 *
+	 * @param array $dependencies List of dependencies to check
+	 * @return bool
+	 */
+	private function check_dependencies(array $dependencies): bool
+	{
+		foreach ($dependencies as $depends)
+		{
+			if (empty($this->data['components'][$depends]))
+			{
+				return false;
+			}
+		}
+		return true;
+	}
+
+	/**
+	 * Handle GitHub Actions specific logic
+	 */
+	private function handle_github_actions(): void
+	{
+		// Lookup table of GitHub Action component settings
+		$github_actions_types = [
+			0 => ['githubactions' => false, 'githubactions_custom' => false], // No (default)
+			1 => ['githubactions' => true, 'githubactions_custom' => false], // Reusable
+			2 => ['githubactions' => false, 'githubactions_custom' => true], // Standalone
+		];
+
+		$question_text = $this->language->lang('SKELETON_QUESTION_COMPONENT_GITHUBACTIONS') . $this->language->lang('COLON');
+		$choices = [];
+		foreach (array_keys($github_actions_types) as $i)
+		{
+			$choices[] = $this->language->lang('SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_CLI', $i);
+		}
+
+		$question = new ChoiceQuestion($question_text, $choices, 0);
+		$choice = $this->helper->ask($this->input, $this->output, $question);
+		$index = array_search($choice, $choices, true);
+
+		$component_settings = $github_actions_types[$index] ?? $github_actions_types[0];
+		$this->data['components'] = array_merge(
+			$this->data['components'] ?? [],
+			$component_settings
+		);
+	}
 }

language/en/common.php

@@ -78,55 +78,60 @@
 	'SKELETON_QUESTION_PHPBB_VERSION_MAX_UI'		=> 'Maximum phpBB requirement of the extension',
 	'SKELETON_QUESTION_PHPBB_VERSION_MAX_EXPLAIN'	=> 'default: <' . \phpbb\skeleton\ext::DEFAULT_PHPBB_MAX,
 
-	'SKELETON_QUESTION_COMPONENT_PHPLISTENER'		=> 'Create sample PHP event listeners?',
+	'SKELETON_QUESTION_COMPONENT_PHPLISTENER'		=> 'Create sample PHP event listeners',
 	'SKELETON_QUESTION_COMPONENT_PHPLISTENER_UI'	=> 'PHP event listeners',
 	'SKELETON_QUESTION_COMPONENT_PHPLISTENER_EXPLAIN'	=> 'PHP event listeners work with core events to inject code into phpBB.',
-	'SKELETON_QUESTION_COMPONENT_HTMLLISTENER'		=> 'Create sample styles listeners?',
+	'SKELETON_QUESTION_COMPONENT_HTMLLISTENER'		=> 'Create sample styles listeners',
 	'SKELETON_QUESTION_COMPONENT_HTMLLISTENER_UI'	=> 'Style listeners',
 	'SKELETON_QUESTION_COMPONENT_HTMLLISTENER_EXPLAIN'	=> 'Style listeners use template events to inject HTML, JS and CSS into phpBB’s style files.',
-	'SKELETON_QUESTION_COMPONENT_ACP'				=> 'Create a sample ACP administration module?',
+	'SKELETON_QUESTION_COMPONENT_ACP'				=> 'Create a sample ACP administration module',
 	'SKELETON_QUESTION_COMPONENT_ACP_UI'			=> 'Administration control panel (ACP)',
 	'SKELETON_QUESTION_COMPONENT_ACP_EXPLAIN'		=> 'Add a functional ACP module for an extension to the ACP’s Extensions tab.',
-	'SKELETON_QUESTION_COMPONENT_MCP'				=> 'Create a sample MCP moderation module?',
+	'SKELETON_QUESTION_COMPONENT_MCP'				=> 'Create a sample MCP moderation module',
 	'SKELETON_QUESTION_COMPONENT_MCP_UI'			=> 'Moderator control panel (MCP)',
 	'SKELETON_QUESTION_COMPONENT_MCP_EXPLAIN'		=> 'Add a functional MCP module tab for an extension to the MCP.',
-	'SKELETON_QUESTION_COMPONENT_UCP'				=> 'Create a sample UCP user module?',
+	'SKELETON_QUESTION_COMPONENT_UCP'				=> 'Create a sample UCP user module',
 	'SKELETON_QUESTION_COMPONENT_UCP_UI'			=> 'User control panel (UCP)',
 	'SKELETON_QUESTION_COMPONENT_UCP_EXPLAIN'		=> 'Add a functional UCP module tab for an extension to the UCP.',
-	'SKELETON_QUESTION_COMPONENT_MIGRATION'			=> 'Create sample database migrations?',
+	'SKELETON_QUESTION_COMPONENT_MIGRATION'			=> 'Create sample database migrations',
 	'SKELETON_QUESTION_COMPONENT_MIGRATION_UI'		=> 'Database migration',
 	'SKELETON_QUESTION_COMPONENT_MIGRATION_EXPLAIN'	=> 'Migration files are used to make database changes.',
-	'SKELETON_QUESTION_COMPONENT_SERVICE'			=> 'Create a sample service?',
+	'SKELETON_QUESTION_COMPONENT_SERVICE'			=> 'Create a sample service',
 	'SKELETON_QUESTION_COMPONENT_SERVICE_UI'		=> 'Service',
 	'SKELETON_QUESTION_COMPONENT_SERVICE_EXPLAIN'	=> 'This is a PHP class that does something behind the scenes. It is a class that can be accessed by controllers, event listeners, or control panel modules.',
-	'SKELETON_QUESTION_COMPONENT_CONTROLLER'		=> 'Create a sample controller?',
+	'SKELETON_QUESTION_COMPONENT_CONTROLLER'		=> 'Create a sample controller',
 	'SKELETON_QUESTION_COMPONENT_CONTROLLER_UI'		=> 'Controller (front page)',
 	'SKELETON_QUESTION_COMPONENT_CONTROLLER_EXPLAIN'=> 'Controllers are typically used for the front-facing files/classes. They run the code that produces the page the user views.',
-	'SKELETON_QUESTION_COMPONENT_EXT'				=> 'Create a sample ext.php?',
+	'SKELETON_QUESTION_COMPONENT_EXT'				=> 'Create a sample ext.php',
 	'SKELETON_QUESTION_COMPONENT_EXT_UI'			=> 'Extension base (ext.php)',
 	'SKELETON_QUESTION_COMPONENT_EXT_EXPLAIN'		=> 'Create the optional ext.php file which can be used to run code before or during extension installation and removal.',
-	'SKELETON_QUESTION_COMPONENT_CONSOLE'			=> 'Create a sample console command?',
+	'SKELETON_QUESTION_COMPONENT_CONSOLE'			=> 'Create a sample console command',
 	'SKELETON_QUESTION_COMPONENT_CONSOLE_UI'		=> 'Console command',
 	'SKELETON_QUESTION_COMPONENT_CONSOLE_EXPLAIN'	=> 'A functional CLI interface to perform console/terminal commands.',
-	'SKELETON_QUESTION_COMPONENT_CRON'				=> 'Create a sample cron task?',
+	'SKELETON_QUESTION_COMPONENT_CRON'				=> 'Create a sample cron task',
 	'SKELETON_QUESTION_COMPONENT_CRON_UI'			=> 'Cron task',
 	'SKELETON_QUESTION_COMPONENT_CRON_EXPLAIN'		=> 'Add a cron task to be able to schedule and run cron-based actions from an extension.',
-	'SKELETON_QUESTION_COMPONENT_NOTIFICATION'		=> 'Create a sample notification?',
+	'SKELETON_QUESTION_COMPONENT_NOTIFICATION'		=> 'Create a sample notification',
 	'SKELETON_QUESTION_COMPONENT_NOTIFICATION_UI'	=> 'Notifications',
 	'SKELETON_QUESTION_COMPONENT_NOTIFICATION_EXPLAIN'	=> 'Notifications allow an extension to notify users of specific activities. When choosing notifications, do not use phpBB 3.1 as the minimum requirement. Notifications changed in phpBB 3.2.0 and are not backwards compatible with 3.1.x.',
-	'SKELETON_QUESTION_COMPONENT_PERMISSIONS'		=> 'Create sample permissions?',
+	'SKELETON_QUESTION_COMPONENT_PERMISSIONS'		=> 'Create sample permissions',
 	'SKELETON_QUESTION_COMPONENT_PERMISSIONS_UI'	=> 'Permissions',
 	'SKELETON_QUESTION_COMPONENT_PERMISSIONS_EXPLAIN'	=> 'Permissions can be used to grant users, groups and roles access to specific extension features.',
-	'SKELETON_QUESTION_COMPONENT_TESTS'				=> 'Create sample PHPUnit tests?',
+	'SKELETON_QUESTION_COMPONENT_TESTS'				=> 'Create sample PHPUnit tests',
 	'SKELETON_QUESTION_COMPONENT_TESTS_UI'			=> 'Tests (PHPUnit)',
 	'SKELETON_QUESTION_COMPONENT_TESTS_EXPLAIN'		=> 'Unit tests can test an extension to verify that specific portions of its source code work properly. This helps ensure basic code integrity and prevents regressions as an extension is being developed and debugged.',
-	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS'		=> 'Create a GitHub Actions workflow to run tests in your repository?',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS'		=> 'Create a GitHub Actions workflow',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_CLI'	=> [
+		0	=> 'No (Default)',
+		1	=> 'Reusable (Recommended - uses phpBB\'s maintained workflow)',
+		2	=> 'Standalone (Deprecated - customise and maintain your own workflow)',
+	],
 	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_UI'	=> 'GitHub Actions Workflow (Reusable – Recommended)',
 	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_EXPLAIN'	=> 'Creates a GitHub Actions workflow that uses a reusable, phpBB-maintained framework to run PHPUnit tests on your repository. The workflow file is saved in .github/workflows and runs automatically on each commit and pull request.',
-	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_CUSTOM'	=> 'Create a fully customisable GitHub Actions workflow? (Select this if you plan to modify jobs or steps.)',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_CUSTOM'	=> 'Create a standalone GitHub Actions workflow [Deprecated: not recommended unless you plan to modify jobs or steps]',
 	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_CUSTOM_UI'	=> 'GitHub Actions Workflow (Standalone – Deprecated)',
 	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_CUSTOM_EXPLAIN'	=> 'Deprecated: Creates a fully standalone workflow to run PHPUnit tests without using the shared phpBB framework. This overrides the reusable workflow and is no longer recommended. The file is saved in .github/workflows and runs on each commit and pull request.',
-	'SKELETON_QUESTION_COMPONENT_BUILD'				=> 'Create a sample build script for phing?',
+	'SKELETON_QUESTION_COMPONENT_BUILD'				=> 'Create a sample build script for phing',
 	'SKELETON_QUESTION_COMPONENT_BUILD_UI'			=> 'Build script (phing)',
 	'SKELETON_QUESTION_COMPONENT_BUILD_EXPLAIN'		=> 'A phing build script is generated for your extension which can be used to generate build packages to help simplify the release or deployment processes.',
 

tests/console/create_test.php

@@ -97,6 +97,12 @@ public function setUp(): void
 					'files'        => ['.github/workflows/tests.yml'],
 					'group'        => 'TEST_DEPLOY',
 				],
+				'githubactions_custom' => [
+					'default'      => false,
+					'dependencies' => [],
+					'files'        => ['.github/workflows/tests.yml'],
+					'group'        => 'TEST_DEPLOY',
+				],
 			]);
 	}
 
@@ -184,7 +190,8 @@ public function get_questions()
 //			'SKELETON_QUESTION_COMPONENT_NOTIFICATION'	=> 'y',
 //			'SKELETON_QUESTION_COMPONENT_PERMISSIONS'	=> 'y',
 			'SKELETON_QUESTION_COMPONENT_TESTS'			=> 'y',
-			'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS'	=> 'y',
+			'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS'	=> 0,
+			'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_CUSTOM'	=> null,
 //			'SKELETON_QUESTION_COMPONENT_BUILD'			=> 'y',
 		];
 	}