Merge branch 'master' into dev/4.0

Author: iMattPro

.gitattributes

@@ -1,7 +1,5 @@
 /tests/			export-ignore
-/travis/		export-ignore
 .github/        export-ignore
-.travis.yml		export-ignore
 .gitignore		export-ignore
 .gitattributes	export-ignore
 phpunit.xml.dist	export-ignore

.github/workflows/tests.yml

@@ -16,14 +16,10 @@ on:
 
 jobs:
     call-tests:
+        name: Extension tests
         uses: phpbb-extensions/test-framework/.github/workflows/tests.yml@master
         with:
-            EXTNAME: phpbb/skeleton   # Your extension vendor/package name
-            SNIFF: 1             # Run code sniffer on your code? 1 or 0
-            IMAGE_ICC: 1         # Run icc profile sniffer on your images? 1 or 0
-            EPV: 0               # Run EPV (Extension Pre Validator) on your code? 1 or 0
-            EXECUTABLE_FILES: 1  # Run check for executable files? 1 or 0
+            EXTNAME: phpbb/skeleton # Your extension vendor/package name
             CODECOV: 1           # Run code coverage via codecov? 1 or 0
-            PHPBB_BRANCH: master # The phpBB branch to run tests on
         secrets:
             CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} # Do not change this

CHANGELOG.md

@@ -1,16 +1,28 @@
 # Changelog
 
+## 1.1.15 - 2025-04-30
+
+- Added a header section to the Skeleton with key links to its documentation, phpBB’s coding guidelines, and extension policies.
+- Added direct documentation links to each section of the Skeleton’s interface for quicker access.
+- Updated GitHub Actions to generate a tests.yml using phpBB’s reusable test framework by default, while still supporting the original standalone tests.yml for custom setups.
+- Removed Travis CI, as it is no longer supported by phpBB and no longer free for open source projects.
+- Decoupled GitHub Actions workflow generation from PHPUnit test generation—each can now be created independently.
+
+## 1.1.14 - 2025-04-20
+
+- Updated GitHub action workflows to address compatibility and bug issues.
+
 ## 1.1.13 - 2025-01-19
 
 - Fixed an issue where test suite files failed to be located and created.
-- Minor code improvements and clean up.
+- Minor code improvements and cleanup.
 
 ## 1.1.12 - 2024-09-29
 
 - Updated GitHub action workflows to address compatibility and bug issues.
 - Added PHP 8.4 testing to GitHub action workflows.
 - Ensure Skeleton extension can only be installed on compatible versions of phpBB.
-- Minor code improvements and clean up.
+- Minor code improvements and cleanup.
 
 ## 1.1.11 - 2023-12-29
 
@@ -22,7 +34,7 @@
 - Updated GitHub Actions workflow files.
 - Removed translation of *CP module page titles as it's not necessary.
 - Updated the Skeleton icon.
-- Minor code improvements and clean up.
+- Minor code improvements and cleanup.
 
 ## 1.1.9 - 2022-06-17
 
@@ -33,25 +45,25 @@
 - Updated minimum requirements: PHP 5.6 and phpBB 3.2.3.
 - Fixed unexpected errors for phpBB and PHP version constraints using ">" and "<" characters.
 - Internally, some minor code improvements.
-- Internally, switched to NPM to manage 3rd party package dependencies.
+- Internally, switched to NPM to manage third party package dependencies.
 - Internally, implemented unit and functional test coverage for code reliability.
 
 ## 1.1.7 - 2021-05-28
 
 - Added validation on user input for homepage URLs, author email addresses, and version requirement patterns.
-- Fixed validation of extension display name when using the CLI.
+- Fixed validation of the extension display name when using the CLI.
 - Internally moved the creation of extension composer.json from PHP logic to a TWIG template.
 - Updated default phpBB version max requirement to <4.0.0@dev.
 
 ## 1.1.6 - 2020-12-28
 
-- Added option to generate GitHub Actions workflow for Continuous Integration testing.
+- Added an option to generate GitHub Actions workflow for Continuous Integration testing.
 - Fixed an issue that prevented dot-files and dot-directories from being generated.
 - Updated some syntax in the sample PHPUnit test files.
 
 ## 1.1.5 - 2020-09-11
 
-- Make sure config created for cron by migration is dynamic.
+- Make sure the config created for cron by migration is dynamic.
 - Updated all PHP arrays to use modern shortened syntax.
 - Updated Travis config files.
 - Updated Read Me files.
@@ -70,7 +82,7 @@
 - Will now use Twig template namespaces for rendering template files in generated controller files.
 - Will now generate Travis-CI tests to run against phpBB 3.3.x (unless you specify an earlier version of phpBB as a maximum version constraint).
 - Will attempt to do a better job of creating the correct notification files, based on your phpBB version constraints.
-- Removed 3rd party Symfony components previously required in phpBB 3.1 installs, resulting in much faster performance.
+- Removed third party Symfony components previously required in phpBB 3.1 installations, resulting in much faster performance.
 - Loads of additional little code inspection fixes.
 
 ## 1.1.2 - 2019-07-13
@@ -81,7 +93,7 @@
 
 - Added a new Permissions component to generate skeleton files that add and use permissions in an extension.
 - Improved the handling of special characters in the Display Name. Now &, < and > are displayed correctly, while double-quotes are strictly invalid.
-- Improved the generated sample migration file with a lot more documented examples of configs, config_text, permissions and custom functions.
+- Improved the generated sample migration file with a lot more documented examples of configs, config_text, permissions, and custom functions.
 - Improved the depends_on() values in generated migration files.
 - Improved the naming of generated control panel language variables.
 - Improved the generation of skeleton files so that only files for the selected components will be built.
@@ -95,9 +107,9 @@
 - Skeleton updates:
 	- Skeleton files have dropped the use of "Acme" and "Demo" in favor of your own vendor and extension names. 
 	- Skeleton template files now use TWIG syntax instead of old phpBB 3.0 style template syntax.
-	- Improved distinctions between skeletons designed to be compatible with phpBB >=3.1 vs >=3.2. For example, skeletons built to support 3.1 and above will still use the User object for language functions, while skeletons built for 3.2 and above will use the newer Language object for language functions.
+	- Improved distinctions between skeletons designed to be compatible with phpBB >=3.1 vs. >=3.2. For example, skeletons built to support 3.1 and above will still use the User object for language functions, while skeletons built for 3.2 and above will use the newer Language object for language functions.
 	- All skeleton files have been overhauled with improved DocBlock and sample code that exemplifies phpBB's coding guidelines and best practices.
-	- ACP, UCP and MCP modules have been updated to utilise controller classes.
+	- ACP, UCP, and MCP modules have been updated to utilise controller classes.
 
 ## 1.0.7 - 2018-03-14
 
@@ -114,32 +126,32 @@
 
 ## 1.0.4 - 2017-05-04
 
-- Updated generated composer.json files to include the composer/installers requirement.
-- Updated generated acp_demo_body.html template to follow a more correct ACP layout configuration.
-- Updated generated acp main_module.php to generate use the correct error flags in trigger_errors.
-- Switched skeleton's nav-bar icon to an SVG image for better style & retina display compatibility.
+- Updated the generated composer.json files to include the composer/installers requirement.
+- Updated the generated acp_demo_body.html template to follow a more correct ACP layout configuration.
+- Updated the generated acp main_module.php to generate use the correct error flags in trigger_errors.
+- Switched skeleton's nav-bar icon to an SVG image for better style and retina display compatibility.
 
 ## 1.0.3 - 2017-01-12
 
 - Add support for UTF-8 characters in fields (extension full name, description, author info, etc.).
 - Only add information about unit testing to the README when testing components are selected.
-- Fix the extension name used in the generated build script component.
-- Fix undeclared class properties generated in the ACP module component.
-- Fix missing empty new line at the end of the generated composer.json file.
-- Increased minimum PHP requirement to PHP 5.4 to support proper JSON file generation (such as UTF-8 support).
+- Fixed the extension name used in the generated build script component.
+- Fixed undeclared class properties generated in the ACP module component.
+- Fixed the missing empty new line at the end of the generated composer.json file.
+- Increased the minimum PHP requirement to PHP 5.4 to support proper JSON file generation (such as UTF-8 support).
 
 ## 1.0.2 - 2016-11-19
 
 - Re-organized some of the "Extension packaging" fields with clearer names and ordering.
-- Shortened the name of the nav-bar link in the web interface to "Skeleton Extension".
+- Shortened the name of the nav-bar link in the web interface to Skeleton Extension.
 - Helpful tooltips have been added to each of the checkboxes in the "Components" section of the web interface.
 - Added a link to Skeleton Extension's Documentation in the web interface.
 - Added warnings when trying to use 'phpbb' or 'core' as vendor and extension names.
 - Added view online page sample code to the event listener for the controller component.
 - Added a missing migration file to generated UCP components.
 - Fixed an issue where the controller component did not generate a correct event listener.
 - Fixed an issue where the controller component did not generate a template event listener for the controller's nav-bar link.
-- Fixed an issue where the notifications component did not generate a valid ext.php (references to the notification services will now have the correct vendor and ext names instead of "dev.dev").
+- Fixed an issue where the notification component did not generate a valid ext.php (references to the notification services will now have the correct vendor and ext names instead of "dev.dev").
 - Use the correct Symfony syntax for non-shared services: `scope: prototype` in phpBB 3.1.x and `shared: false` in phpBB 3.2.
 
 ## 1.0.1 - 2016-10-13

build.xml

@@ -15,10 +15,8 @@
 		-->
 		<delete dir="${dir}/.github" />
 		<delete dir="${dir}/tests" />
-		<delete dir="${dir}/travis" />
 
 		<delete file="${dir}/.gitignore" />
-		<delete file="${dir}/.travis.yml" />
 		<delete file="${dir}/build.xml" />
 		<delete file="${dir}/composer.lock" />
 		<delete file="${dir}/composer.phar" />

config/skeletons.yml

@@ -155,7 +155,7 @@ services:
             - 'tests'
             - false
             - []
-            - ['tests/controller/main_test.php', 'tests/dbal/fixtures/config.xml', 'tests/dbal/simple_test.php', 'tests/functional/view_test.php', 'phpunit.xml.dist']
+            - ['tests/controller/main_test.php', 'tests/dbal/fixtures/config.xml', 'tests/dbal/simple_test.php', 'tests/functional/view_test.php', 'phpunit.xml.dist', '.github/workflows/tests.yml']
             - 'TEST_DEPLOY'
         tags:
             - { name: phpbb.skeleton.ext.skeleton }
@@ -165,19 +165,19 @@ services:
         arguments:
             - 'githubactions'
             - false
-            - ['tests']
+            - []
             - ['.github/workflows/tests.yml']
             - 'TEST_DEPLOY'
         tags:
             - { name: phpbb.skeleton.ext.skeleton }
 
-    phpbb.skeleton.ext.skeleton.travis:
+    phpbb.skeleton.ext.skeleton.githubactions_custom:
         class: phpbb\skeleton\skeleton
         arguments:
-            - 'travis'
+            - 'githubactions_custom'
             - false
-            - ['tests']
-            - ['travis/prepare-phpbb.sh', '.travis.yml']
+            - []
+            - ['.github/workflows/tests.yml']
             - 'TEST_DEPLOY'
         tags:
             - { name: phpbb.skeleton.ext.skeleton }

helper/packager.php

@@ -95,7 +95,7 @@ public function get_component_dialog_values()
 			$components[$service->get_name()] = [
 				'default'      => $service->get_default(),
 				'dependencies' => $service->get_dependencies(),
-				'files'        => $service->get_files(),
+				'files'         => $service->get_files(),
 				'group'        => $service->get_group(),
 			];
 		}

language/en/common.php

@@ -24,8 +24,9 @@
 $lang = array_merge($lang, [
 	'CLI_DESCRIPTION_SKELETON_CREATE'	=> 'Create a basic skeleton extension',
 	'PHPBB_SKELETON_EXT'				=> 'Skeleton Extension',
-	'PHPBB_CREATE_SKELETON_EXT'			=> 'Create skeleton extension',
-	'PHPBB_SKELETON_EXT_DOCS'			=> 'Read the Documentation',
+	'PHPBB_CREATE_SKELETON_EXT'			=> 'Create a Skeleton Extension',
+	'PHPBB_CREATE_SKELETON_EXPLAIN'		=> 'Generate your extension’s foundation in seconds. No more setting up files by hand — Skeleton builds it all for you, with clean, fully documented templates based on phpBB’s best practices. Before you begin, be sure to review the 📖 [<a href="%1$s" target="_blank">Skeleton Extension Documentation</a>], 🛡️ [<a href="%2$s" target="_blank">Extension Validation Rules</a>], and 🛠️ [<a href="%3$s" target="_blank">Coding Guidelines</a>].',
+	'PHPBB_SKELETON_EXT_HELP'			=> 'Learn More',
 
 	'EXTENSION_CLI_SKELETON_SUCCESS'	=> "<info>Extension created successfully.\nCopy the extension from `store/tmp-ext/` into the `ext/` folder.</info>",
 	'SKELETON_CLI_COMPOSER_QUESTIONS'	=> '<comment>Enter composer.json details (hit enter to leave an option empty)</comment>',
@@ -119,12 +120,12 @@
 	'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 workflow for test execution using Github Actions?',
-	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_UI'	=> 'Github Actions CI configuration',
-	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_EXPLAIN'	=> 'Github Actions allow you to run PHPUnit tests on your GitHub repository. This will generate the workflow YML needed to begin testing your phpBB extension with each commit and pull request. Note that this workflow will be inside a hidden folder (.github/workflows).',
-	'SKELETON_QUESTION_COMPONENT_TRAVIS'			=> 'Create a sample for test execution on Travis CI?',
-	'SKELETON_QUESTION_COMPONENT_TRAVIS_UI'			=> 'Travis CI configuration',
-	'SKELETON_QUESTION_COMPONENT_TRAVIS_EXPLAIN'	=> 'Travis CI is a platform for running your PHPUnit tests on a GitHub repository. This will generate the basic config and script files needed to begin testing your phpBB extension with each commit and pull request.',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS'		=> 'Create a GitHub Actions workflow to run tests in your repository?',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_UI'	=> 'Github Actions workflow',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_EXPLAIN'	=> 'Creates a GitHub Actions workflow to run PHPUnit tests on your repository using a framework maintained by phpBB. The workflow YML file will be placed in the .github/workflows folder and will run tests 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_UI'	=> 'Github Actions custom workflow',
+	'SKELETON_QUESTION_COMPONENT_GITHUBACTIONS_CUSTOM_EXPLAIN'	=> 'Creates a customisable GitHub Actions workflow to run PHPUnit tests on your repository. This workflow is flexible to fit your specific testing needs and will be saved in the .github/workflows folder, triggered by each commit and pull request. Choosing this will override the non-customisable workflow.',
 	'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.',

skeleton/.github/workflows/tests.yml.twig

@@ -1,5 +1,6 @@
 name: Tests
 
+{% if COMPONENT.githubactions_custom %}
 env:
     EXTNAME: {{ EXTENSION.vendor_name }}/{{ EXTENSION.extension_name }} # Your extension vendor/package name
     SNIFF: 1            # Run code sniffer on your code? 1 or 0
@@ -336,9 +337,9 @@ jobs:
                     - php: '7.2'
                       db: "mcr.microsoft.com/mssql/server:2019-CU27-ubuntu-20.04"
                       db_alias: 'MSSQL 2019'
-					- php: '7.2'
-					  db: "mcr.microsoft.com/mssql/server:2022-CU13-ubuntu-22.04"
-					  db_alias: 'MSSQL 2022'
+                    - php: '7.2'
+                      db: "mcr.microsoft.com/mssql/server:2022-CU13-ubuntu-22.04"
+                      db_alias: 'MSSQL 2022'
 
         name: PHP ${{ '{{' }} matrix.php }} - ${{ '{{' }} matrix.db_alias != '' && matrix.db_alias || matrix.db }}
 
@@ -424,3 +425,27 @@ jobs:
               run: phpBB/vendor/bin/phpunit --configuration phpBB/ext/$EXTNAME/.github/phpunit-$DB-github.xml --bootstrap ./tests/bootstrap.php
               working-directory: ./phpBB3
     # END Other Tests Job
+{% else %}
+on:
+    push:
+        branches:        # Run tests when commits are pushed to these branches in your repo
+            - main
+            - master
+            - develop
+            - dev/*
+    pull_request:        # Run tests when pull requests are made on these branches in your repo
+        branches:
+            - main
+            - master
+            - develop
+            - dev/*
+
+jobs:
+    call-tests:
+		name: Extension tests
+        uses: phpbb-extensions/test-framework/.github/workflows/tests.yml@3.3.x
+        with:
+            EXTNAME: {{ EXTENSION.vendor_name }}/{{ EXTENSION.extension_name }} # Your extension vendor/package name
+
+# See the README for full details and setup instructions: https://github.com/phpbb-extensions/test-framework
+{% endif %}