You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: development/extensions/skeleton_extension.rst
+12-50
Original file line number
Diff line number
Diff line change
@@ -730,22 +730,26 @@ functional tests:
730
730
│ └── ...
731
731
└── ...
732
732
733
-
Github Actions CI configuration
733
+
GitHub Actions CI configuration
734
734
-------------------------------
735
735
736
-
Github Actions is a platform for running your PHPUnit tests on a GitHub
737
-
repository.
736
+
GitHub Actions provides a platform to automatically run your PHPUnit tests on each commit and pull request in
737
+
your repository.
738
738
739
-
The Skeleton Extension will generate the basic workflow script file
740
-
needed to test your phpBB extension with each commit and pull request
741
-
pushed to your GitHub repository:
739
+
The Skeleton Extension can generate two types of workflow scripts based on your needs:
740
+
741
+
**GitHub Actions workflow (default):**
742
+
Generates a simplified, reusable workflow containing a few adjustable variables. You can easily enable or disable the types of tests you want to run. This workflow is maintained by phpBB and is designed to test your extension against all the same PHP versions and databases supported by phpBB.
743
+
744
+
**GitHub Actions custom workflow (optional):**
745
+
Generates a fully editable, self-contained workflow for your repository. This option gives you complete control over the jobs and steps, making it ideal if you plan to customise or extend the testing process.
742
746
743
747
::
744
748
745
749
vendor
746
750
├── package
747
-
│ ├── .github # A hidden directory to contain Github related files
748
-
│ │ ├── workflows # A directory to contain any test scripts
751
+
│ ├── .github # A hidden directory to contain GitHub related files
752
+
│ │ ├── workflows # A directory to contain any GitHub workflows
749
753
│ | | ├── tests.yml # The test configuration script in YAML format
750
754
│ │ │ └── ...
751
755
│ │ └── ...
@@ -757,48 +761,6 @@ pushed to your GitHub repository:
757
761
The ``.github`` directory is a hidden folder. You can view and access it
758
762
using a Text Editor or IDE that is capable of displaying hidden folders.
759
763
760
-
.. note::
761
-
762
-
The Skeleton Extension currently does not allow you to generate
763
-
the Github Actions CI component without also generating the PHPUnit tests
764
-
component. This is because without unit tests, there is little
765
-
benefit to using Github Actions.
766
-
767
-
Travis CI configuration
768
-
-----------------------
769
-
770
-
Travis CI is a platform for running your PHPUnit tests on a GitHub
771
-
repository.
772
-
773
-
The Skeleton Extension will generate the basic config and script files
774
-
needed to test your phpBB extension with each commit and pull request
775
-
pushed to your GitHub repository:
776
-
777
-
::
778
-
779
-
vendor
780
-
├── package
781
-
│ ├── .travis.yml # A Travis CI configuration file
782
-
│ ├── tests # Dir containing PHPUnit tests
783
-
│ ├── travis # Dir containing Travis CI scripts
784
-
│ │ ├── prepare-phpbb.sh # Script required by Travis CI during testing (do not edit)
785
-
│ │ └── ...
786
-
│ └── ...
787
-
└── ...
788
-
789
-
.. warning::
790
-
791
-
The ``.travis.yml`` is a hidden file. You can view and edit it
792
-
using a Text Editor or IDE that is capable of displaying hidden
793
-
files.
794
-
795
-
.. note::
796
-
797
-
The Skeleton Extension currently does not allow you to generate
798
-
the Travis CI component without also generating the PHPUnit tests
799
-
component. This is because without unit tests, there is little
0 commit comments