Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/workofstan/seablast-actions

This curated collection of prefabricated GitHub Actions is designed to supercharge your PHP projects with reusable workflows. Streamline your development process and ensure consistent build, test, and deployment practices across all your PHP applications.
https://github.com/workofstan/seablast-actions

automation continuous-integration github-actions

Last synced: 3 months ago
JSON representation

This curated collection of prefabricated GitHub Actions is designed to supercharge your PHP projects with reusable workflows. Streamline your development process and ensure consistent build, test, and deployment practices across all your PHP applications.

Awesome Lists containing this project

README 

          
# seablast-actions



This curated collection of prefabricated GitHub Actions is designed to supercharge your PHP projects with reusable workflows.

Streamline your development process and ensure consistent build, test, and deployment practices across all your PHP applications.



Supports: "php": "5.6 || ^7.0 || ^8.0"



## Example



See  for an actual example.



Note that there are two ways to chain jobs (as typically you want to lint a code only if it is actually working [not to waste computing time]).

One is to trigger workflows by running another workflow successfully first:



```yaml

on:

  workflow_run:

    workflows:

      - First Action

    types:

      - completed

```



but as this condition works **ONLY** on the default branch, and typically you need to run workflows on dev branches to make sure the code is working and well formatted,

there's the second way. Chaining jobs within a single workflow by using `needs` command.

See  for an actual example.



## Test composer dependencies, PHPUnit tests (incl. database) and PHPStan check



```yml

jobs:

  # Note: https://docs.github.com/en/actions/using-workflows/reusing-workflows The strategy property is not supported in any job that calls a reusable workflow.

  call-workflow:

    uses: WorkOfStan/seablast-actions/.github/workflows/php-composer-dependencies-reusable.yml@main

    with:

      # REQUIRED (JSON string)

      php-version: '["7.2", "7.3", "7.4"]'

      # OPTIONAL: path with the default database configuration

      phinx-config: "phinx.dist.yml"

      # OPTIONAL: path where the app expects the local database configuration

      phinxlocal-config: "phinx.yml"

      # OPTIONAL: path to phpdist-config specimen which is used to create the actual phplocal-config

      phpdist-config: "./conf/app.conf.dist.php"

      # OPTIONAL: path where the app code is looking for the local app configuration

      phplocal-config: "./conf/app.conf.local.php"

      # OPTIONAL: runner specification

      runs-on: "ubuntu-latest"

```



PHPUnit tests fire up only if `conf/phpunit-github.xml` is present. (This configuration may be different from the usual `./phpunit.xml`.)



### Caching Mechanism



To optimize execution time, the `vendor` folder is cached, allowing dependencies to be reused across workflow runs. The cache key is generated based on:



- `composer.json` – to track dependency changes.

- The runner's OS and PHP version – to account for environment-specific variations.



This approach enables cache sharing across branches. However, if the code in the referenced branch (e.g., `dev`) changes, it's recommended to **invalidate the cache** to ensure a fresh `vendor` folder is built from scratch.



The cache name (key) is `phps-${{ runner.os }}-PHP${{ matrix.php-version }}-vendor-${{ hashFiles('**/composer.json') }}` (because the vendor folder includes PHPStan)



## Basic PHP linter



```yml

jobs:

  # Note: https://docs.github.com/en/actions/using-workflows/reusing-workflows The strategy property is not supported in any job that calls a reusable workflow.

  call-workflow:

    uses: WorkOfStan/seablast-actions/.github/workflows/overtrue-phplint.yml@main

    with:

      # OPTIONAL runner specification

      runs-on: "ubuntu-latest"

```



## [Super-Linter](https://github.com/super-linter/super-linter) of many formats



```yml

jobs:

  # Note: https://docs.github.com/en/actions/using-workflows/reusing-workflows The strategy property is not supported in any job that calls a reusable workflow.

  call-workflow:

    uses: WorkOfStan/seablast-actions/.github/workflows/linter.yml@main

    with:

      # OPTIONAL parameter for REGEX to exclude certain files, e.g. third-party code, from being linted

      filter-regex-exclude: ".*/assets/third-party/.*"

      # OPTIONAL Change how much output the script will generate to the console. One of `ERROR`, `WARN`, `NOTICE`, `INFO` (default), or `DEBUG`.

      log-level: "DEBUG"

      # OPTIONAL runner specification

      runs-on: "ubuntu-latest"

      # OPTIONAL enable Biome validation

      validate-biome: true

      # OPTIONAL disable CSS validation, as it pushes for a modern CSS which might not be backward compatible

      validate-css: false

      # OPTIONAL enable SPELL_CODESPELL validation. It treats words from other languages than English as typos. Creating ignore/allowlist is impractical. Use with caution.

      validate-spell-codespell: true

```



With the release of [Super-Linter](https://github.com/super-linter/super-linter) 7.0.0, [Prettier](https://prettier.io/) has become the standard for many file formats, ensuring consistent code styling across your projects.

Embrace this change and keep your codebase looking sharp by integrating Prettier directly into your workflow: [prettier-fix](https://github.com/marketplace/actions/prettier-fix).



Note 1: It's not possible to select super-linter version through a parameter, as the `uses` field expects a static string.



Note 2: slim [variant](https://github.com/super-linter/super-linter?tab=readme-ov-file#super-linter-variants) is used for sake of efficiency as these linters are not used in PHP anyway: Rustfmt, Rust Clippy, Azure Resource Manager Template Toolkit (arm-ttk), PSScriptAnalyzer, dotnet (.NET) commands and subcommands.



Note 3: Many FIXes are applied automatically and their result can be downloaded as an artifact and then use locally with `git apply lint-fixes.patch`. If the change is in the `.github/workflows`, it can't be commited by a GitHub Action anyway.



Note 4: any composer.json automatically temporarily renamed (and then renamed back) to prevent invoking composer within super-linter, as the environment PHP version (which might not be app relevant) is used and various libraries would be expected that are not part of super-linter environment.



Note 5: Copy/paste detection with the default threshold 0% is too strict. Todo consider parametric JSCPD_CONFIG_FILE . So far: `VALIDATE_JSCPD: false`



Note 6: You can either use your own zizmor.yaml or the GitHub Action auto-generates such [zizmor.yaml](.github/linters/zizmor.yaml) to disable unpinned-uses check. That allows referring to an action by version tag instead of exact hash, so that Dependabot can monitor and update versions automatically.



## Automatic PHP Code Style improvements



Use [PHPCS-Fix](https://github.com/WorkOfStan/phpcs-fix/blob/main/.github/workflows/phpcs-phpcbf.yml).