README_plugins.md

• Using pkp-github-actions in Plugins
  • Plugin content
    • Running environments
    • adding github action
    • List of plugins
• Custom tests

Using pkp-github-actions in Plugins

To enable CI/Cd tests in your plugin please create a yml file in the folder .github/workflows Please note that you need to create the yml file in each branch for different major versions of OJS/OMP and OPS.

Plugin content

The content of the yml file should look similar to the following content.

01: on: [push]
02: name: jobName
03: jobs:
04:   jobName:
05:     runs-on: ubuntu-latest
06:     strategy:
07:       fail-fast: false
08:       matrix:
09:         include:
10:           - application: ojs
11:             php-version: 8.3
12:             database: mysql
13:           - application: omp
14:             php-version: 8.2
15:             database: mysql
16:
17:     name: myplugin
18:     steps:
19:       - uses: pkp/pkp-github-actions@v1
20:         with:
21:           node_version: 20 # node 16 for ojs 3.4 , node 12 for ojs 3.3
22:           branch: main
23:           repository: pkp
24:           plugin: true
25:           dataset_inject: true # optional

Example

• https://github.com/pkp/pluginTemplate/blob/main/.github/workflows/main.yml

Running environments

To run your Github actions under different configurations, Github actions allow you to configure a matrix In this matrix, you can specify the application, the PHP version and the database which your plugin should be running on. in the above example, see the lines 10-15

adding github action

• Line 19: adds the Github Action to the current plugin
• Line 21: which node version should be used. OJS 3.5 uses node 20, OJS 3.4 uses node 16 and OJS 3.3 uses node 12
• Line 22: the branch that the application is targeted at
• Line 23: the repository from which the OJS/OMP/OPS code is taken for testing. You can use your local repository, but pkp is recommended.
• Line 24: mandatory: says, that this is a plugin
• Line 25: dataset_inject true, only if you need a complete working database, before testing.

List of plugins

Plugin	Software	main	3.4.0	3.3.0
classic	OJS		---
customBlockManager	OJS
customHeader	OJS		---
customLocale	ALL
defaultManuscript	OJS
healthSciences	OJS
immersion	OJS		---	---
lucene	OJS		---
oaiJats	OJS
pluginTemplate	OJS			---
pragma	OJS
quickSubmit	OJS
staticPages	ALL
webFeed	ALL

Custom tests

To run your plugin tests, you have to create a tests.sh file under the directory, .github/actions The content is plugin dependent. See the following examples

Examples

• https://github.com/pkp/oaiJats/blob/main/.github/actions/tests.sh
• https://github.com/pkp/quickSubmit/blob/main/.github/actions/tests.sh