The PKP GitHub Actions facilitate automated testing for continuous integration within OJS, OMP, and OPS.
Presently, PKP applications incorporate unit tests (PHPUnit) and integrated tests (Cypress), alongside upgrade tests. These tests undergo automated execution within a virtual environment, serving to prevent regressions and ensure the functionality of tested workflow steps.
please refer to plugins documentation
GitHub Actions have been integrated into the main and latest stable branches of PKP applications,
and their configuration can be found in the following file_path .github/workflows/main.yml.
In main branch or OJS Versions released after 3.5, you will need the following email setup to locally run the cypress tests.
Sendria: mail server https://pypi.org/project/sendria/
Add the following mail settings to config.inc.php file
default = smtp
smtp = On
smtp_server = localhost
smtp_port = 1025
| Variable | Description | Default |
|---|---|---|
| application | PKP Application (OJS| OMP| OPS) (needed for pkp-lib) | Current application |
| branch | git branch (needed for pkp-lib) | Current branch |
| dataset_branch | Identify the OJS Version: 3_3_0 for pkp/datasets | - |
| debug_in_tmate | When a test fails anywhere, opens a tmate session, with ssh-server. | |
| node_version | can be set manually for older versions eg. 16.1.0 | 20 |
| repository | github repository name (needed for pkp-lib) | Current repository |
| reset_commit | Explicitly test a certain version of PKP Application | - |
| SAVE_BUILD | if set, it will save the database to 'save_build' pkp/datasets | |
| test | run unit and integration tests 'test' | |
| validate | run valiadtoin tests 'validate' | |
| upgrade | run upgrade tests 'upgrade' | |
| upgrade_test | Identify the OJS Version: eg.g 3_3_0, 3_4_0,main for upgrade_tests | - |
1. on: [push, pull_request]
2. name: ojs
3. jobs:
4. main:
5. runs-on: ubuntu-latest
6. strategy:
7. fail-fast: false
8. matrix:
9. include:
10. - php-version: 8.1
11. validate: 'validate'
12. - php-version: 8.1
13. database: pgsql
14. upgrade: 'upgrade'
15. upgrade_test: '3.1.0,3.1.1-2,
16. name: ojs
17. steps:
18. - uses: pkp/pkp-github-actions@v1
19. with :
20. node_version: 20
21. dataset_branch: 'main'
22. DATASETS_ACCESS_KEY: ${{secrets.DATASETS_ACCESS_KEY}}
23. DEBUG_IN_TMATE: false
- Github actions Runs on both
pullandpull requests - name of the workflow
- Defines the number of jobs , per action. We have one job , called main, run on 6 different settings, defined in the matrix.
- Name of the job
- Runner Operating system: default Ubuntu and relies on the containers provided by github.com
- defines the strategy of the current job
- Run all the jobs in matrix independently
matrixconfiguration: defines the number of runners- included tests
-
- Test - Currently tested PHP version
-
- Test - currently tested action type (validate| test| upgrade)12Test - Currently tested PHP version
-
- Test - Currently tested PHP version
-
- Test - currently database type (mysql | pgsql | mariadb)
-
- Test - currently tested action type (validate| test| upgrade)
-
- Test - Upgrade tests from earlier versions
- name: of the action
- General definition for steps
- Default integration is pkp-github-actions for OJS/OMP/OPS applications , but e.g. plugins, may run extra github actions steps or use external github actions.
- Additional configurations
- node_version
- For updating datasets, we have to define with ojs version, main / 3.4.0 / 3.3.0
- Only needed if the datasets get saved to the pkp/datasets, will only used for pkp-machine-user
- This opens a tmate session, if any test fails
1. on: [push, pull_request]
2. name: pkp-lib
3. jobs:
4. pkp-lib:
5. runs-on: ubuntu-latest
6. strategy:
7. fail-fast: false
8. matrix:
9. include:
10. - application: ojs
11. php-version: 7.3
12. database: mysql
13. test: 'test'
14. - application: omp
15. php-version: 7.4
16. database: mysql
17. test: 'test'
18. name: pkp-lib
19. steps:
20. - uses: pkp/pkp-github-actions@v1
21. with:
22. repository: pkp
23. branch: stable-3_3_0
24. node_version: 12
25. DEBUG_IN_TMATE: false
See above for the un-listed definitions.
- The application you are testing agains
- you can define your own repository, if you are developing against that.
- The git branch , you are targetting your tests.
This scenario assumes, you are only doing enhancements or bugfixes to ojs,omp or ops
- Clone branch of your pkp-application to your development environment
git clone -b stable-3_4_0 https://github.com/pkp/ojs $MY_PATH/ojs - Optional: update your pkp-lib and other sub-modules to keep up with changes and include in push commits
git submodule update --init --recursive -f; git add lib/pkp; git commit -m "Submodule update" - Commit and push to your user git repository
- Create your PR to https://github.com/pkp/$application
If you are changing both the pkp-lib and the application, follow one of the following strategies.
- Update .gitmodules File: You would change the URL to point to your repository temporarily for testing purposes.
[submodule "pkp-lib"]
path = pkp-lib
url = https://github.com/your_username/pkp-lib.git
branch = my-feature-branch
Commits to your git user repository will trigger the tests automatically.
E.g. Modify the GitHub workflow file located and commit to pkp-lib
https://github.com/your_username/pkp-lib/tree/feature_branch/.github/workflows/stable-3_4_0.yml
steps:
- uses: pkp/pkp-github-actions@v1
with:
repository:your_username
branch = my-feature-branch
- First create the PR against the pkp-lib
- Then create the application PRs
| Branch | Test-Type | PHP | Database | DATASET_BRANCH | SAVE_BUILD | Container |
|---|---|---|---|---|---|---|
| main | validation | 8.1 | 1 | |||
| main | test | 8.1 | pgsql | x | 2 | |
| main | test | 8.1 | mariadb | x | 3 | |
| main | test | 8.1 | mysql | x | 1 | |
| main | test | 8.2 | mysql | 5 | ||
| main | test | 8.2 | pgsql | 6 | ||
| main | upgrade | 8.1 | mysql | stable-3_4_0 | 1 | |
| main | upgrade | 8.1 | mysql | stable-3_3_0 | 1 | |
| main | upgrade | 8.1 | pgsql | stable-3_4_0 | 6 | |
| main | upgrade | 8.1 | pgsql | stable-3_3_0 | 6 | |
| --- | ---- | ---- | ---- | ---- | ---- | ---- |
| 3.4 | validation | 8 | 1 | |||
| 3.4 | test | 8 | pgsql | x | 2 | |
| 3.4 | test | 8.1 | pgsql | 3 | ||
| 3.4 | test | 8 | mariadb | x | 4 | |
| 3.4 | test | 8.1 | mysql | x | 5 | |
| 3.4 | test | 8.2 | mysql | 6 | ||
| 3.4 | test | 8.2 | pgsql | 7 | ||
| 3.4 | test | 8 | mysql | 7 | ||
| 3.4 | upgrade | 8 | mysql | 3.1.0 | 7 | |
| 3.4 | upgrade | 8 | mysql | 3.1.1-2 | 7 | |
| 3.4 | upgrade | 8 | mysql | 3.1.2 | 7 | |
| 3.4 | upgrade | 8 | mysql | stable-3_2_0 | 7 | |
| 3.4 | upgrade | 8 | mysql | stable-3_2_1 | 7 | |
| 3.4 | upgrade | 8 | mysql | stable-3_3_0 | 7 | |
| 3.4 | upgrade | 8 | pgsql | 3.1.0 | 7 | |
| 3.4 | upgrade | 8 | pgsql | stable-3_2_0 | 7 | |
| 3.4 | upgrade | 8 | pgsql | stable-3_2_1 | 7 | |
| 3.4 | upgrade | 8 | pgsql | stable-3_3_0 | 7 | |
| --- | ---- | ---- | ---- | ---- | ---- | ---- |
| 3.3 | validation | 8 | 1 | |||
| 3.3 | test | 7.3 | pgsql | 2 | ||
| 3.3 | test | 7.3 | mysql | 3 | ||
| 3.3 | test | 7.4 | pgsql | 4 | ||
| 3.3 | test | 7.4 | mysql | 5 | ||
| 3.3 | test | 8 | pgsql | x | 6 | |
| 3.3 | test | 8 | mysql | x | 7 | |
| 3.3 | test | 8.1 | pgsql | 8 | ||
| 3.3 | test | 8.1 | mysql | 9 | ||
| 3.3 | test | 8.2 | mysql | 10 | ||
| 3.3 | test | 8.2 | pgsql | 11 |
- During the development: chat.openai.com used as a help tool