Deprecated

This module is now deprecated, though it will remain operational for the foreseeable future.

You're encouraged to now use its replacement gha-ci

Silverstripe GitHub Actions shared CI config

By default will run Silverstripe Unit tests and PHPCS code linting.

It's highly recommended that you use a tagged version (e.g. 0.1.16) to ensure stability of your builds. If you have a relatively simple build that you have no intention of ever making more complex e.g. only phpunit tests using phpunit.xml.dist, then this is probably all you need for long term use.

This repository is currently in development and code on the main branch could change at any time, including taking on a whole new direction. It's expected that new functionality will be added.

Usage

Create the following file in your module

(subsitute the tagged version for the most recent tag from this module)

.github/workflows/main.yml

name: Module CI

on:
  push:
  pull_request:

jobs:
  ci:
    uses: silverstripe/github-actions-ci-cd/.github/workflows/[email protected]

Use the following if your module does not have a phpcs.xml.dist file

(or better still, copy paste this sample phpcs.xml.dist file in to your module)

jobs:
  ci:
    uses: silverstripe/github-actions-ci-cd/.github/workflows/[email protected]
    with:
      run_phplinting: false

Some other "with" options

Run php coverage run_phpcoverage: true

Run behat tests: run_endtoend: true

Run js tests, linting and build diff: run_js: true

Don't run phpunit tests run_phpunit: false

Don't run php linting (phpcs, phpstan) run_phplinting: false

Update JS dependencies

This workflow will automatically run yarn upgrade to update js dependencies and create a pull-request authored by a github-actions user. Non-admin modules will have the admin module using the 1 branch installed in a sibling directory so that shared components are accessible.

The cron will automatically run using the modules default branch on the first day of every 3rd month - Jan, Apr, Jul, Oct. The action can also be triggered manually.

.github/workflows/update-js-deps.yml

name: Update JS deps
on:
  # Run on a schedule once per quarter
  schedule:
    - cron:  '0 0 1 */3 *'
  workflow_dispatch:
jobs:
  ci:
    uses: silverstripe/github-actions-ci-cd/.github/workflows/[email protected]