typo3-ci-workflows

Reusable GitHub Actions workflows for Netresearch TYPO3 extension repositories.

Workflows

Workflow	Purpose
`ci.yml`	PHP lint, CGL, PHPStan, Rector, unit tests, functional tests
`scorecard.yml`	OpenSSF Scorecard analysis
`codeql.yml`	GitHub CodeQL security scanning
`dependency-review.yml`	Dependency vulnerability review on PRs
`auto-merge-deps.yml`	Auto-merge Dependabot/Renovate PRs
`publish-to-ter.yml`	Publish extension to TYPO3 TER on tag
`labeler.yml`	Automatic PR labeling based on file paths
`lock.yml`	Lock old inactive issues and PRs
`greetings.yml`	Greet first-time contributors
`docs.yml`	Render and verify TYPO3 documentation
`stale.yml`	Mark and close stale issues and PRs
`license-check.yml`	PHP dependency license audit
`security.yml`	Gitleaks secret scanning + Composer audit
`pr-quality.yml`	PR size check + auto-approve for solo maintainers
`release.yml`	Enterprise release pipeline (archive, SBOM, cosign, attestation)
`fuzz.yml`	Fuzz tests and mutation testing with Infection
`slsa-provenance.yml`	SLSA Level 3 provenance generation

Quick Start

Create .github/workflows/ci.yml in your extension repository:

name: CI
on:
  push:
  pull_request:
permissions: {}
jobs:
  ci:
    uses: netresearch/typo3-ci-workflows/.github/workflows/ci.yml@main
    permissions:
      contents: read
    with:
      php-versions: '["8.2", "8.3", "8.4"]'
      typo3-versions: '["^13.4", "^14.0"]'

CI Workflow Inputs

Matrix Configuration

Input	Type	Default	Description
`php-versions`	string	`'["8.4"]'`	JSON array of PHP versions
`typo3-versions`	string	`'["^13.4"]'`	JSON array of TYPO3 versions
`matrix-exclude`	string	`'[]'`	JSON array of `{php, typo3}` combinations to exclude
`typo3-packages`	string	`'["typo3/cms-core"]'`	JSON array of TYPO3 packages to require

Feature Flags

Input	Type	Default	Description
`run-lint`	boolean	`true`	Run PHP syntax lint
`run-cgl`	boolean	`true`	Run code style check (PHP-CS-Fixer)
`run-phpstan`	boolean	`true`	Run PHPStan static analysis
`run-rector`	boolean	`true`	Run Rector dry-run
`run-unit-tests`	boolean	`true`	Run PHPUnit unit tests
`run-functional-tests`	boolean	`false`	Run PHPUnit functional tests

Custom Commands

Override auto-detection with custom commands:

Input	Type	Default
`cgl-command`	string	auto-detect
`phpstan-command`	string	auto-detect
`rector-command`	string	auto-detect
`unit-test-command`	string	auto-detect
`functional-test-command`	string	auto-detect

Auto-detection looks for these composer scripts (in order):

CGL: ci:test:php:cgl, ci:cgl (+ --dry-run), ci:lint:php, check:php:cs-fixer, code:style:check
PHPStan: ci:test:php:phpstan (+ --error-format=github), ci:phpstan (+ --error-format=github), ci:stan, check:php:stan, code:phpstan
Rector: ci:test:php:rector, check:php:rector
Unit tests: ci:test:php:unit (+ --no-coverage/--coverage-clover), ci:tests:unit, check:tests:unit, test:unit
Functional tests: ci:test:php:functional (+ --no-coverage/--coverage-clover), ci:tests:functional, check:tests:functional, test:functional

Note: Some scripts get additional arguments appended automatically (shown in parentheses). Ensure your composer scripts accept -- pass-through arguments.

PHP Extensions

Input	Type	Default	Description
`php-extensions`	string	`intl, mbstring, xml`	PHP extensions to install

CGL and Rector run on the first PHP version only (code style is PHP-version-independent). PHPStan and tests run on the full matrix.

Functional Tests

Input	Type	Default	Description
`functional-test-db`	string	`sqlite`	Database: `sqlite`, `mysql`, `mariadb`, `postgres`
`db-image`	string	`mysql:9.6`	Docker image for database service

Coverage

Input	Type	Default	Description
`upload-coverage`	boolean	`false`	Upload coverage to Codecov
`coverage-tool`	string	`pcov`	Coverage driver: `pcov` or `xdebug`

Requires CODECOV_TOKEN secret when enabled.

Incompatible Dev Dependencies

Remove dev dependencies that are incompatible with certain TYPO3 versions:

remove-dev-deps: '[{"dep":"saschaegerer/phpstan-typo3","only-for":"^12|^13"}]'

The only-for field supports pipe-separated version prefixes. Dependencies are removed when the TYPO3 version doesn't match any pattern.

Other Workflows

Scorecard

jobs:
  scorecard:
    uses: netresearch/typo3-ci-workflows/.github/workflows/scorecard.yml@main
    permissions:
      contents: read
      security-events: write
      id-token: write
      actions: read

CodeQL

jobs:
  codeql:
    uses: netresearch/typo3-ci-workflows/.github/workflows/codeql.yml@main
    permissions:
      contents: read
      security-events: write
      actions: read

Input	Type	Default	Description
`languages`	string	`actions`	CodeQL languages to analyze (comma-separated)

Dependency Review

jobs:
  dependency-review:
    uses: netresearch/typo3-ci-workflows/.github/workflows/dependency-review.yml@main
    permissions:
      contents: read
      pull-requests: write

Input	Type	Default	Description
`fail-on-severity`	string	`high`	Minimum severity to fail on (`low`, `moderate`, `high`, `critical`)

Auto-merge Dependency PRs

jobs:
  auto-merge:
    uses: netresearch/typo3-ci-workflows/.github/workflows/auto-merge-deps.yml@main
    permissions:
      contents: write
      pull-requests: write

Publish to TER

jobs:
  publish:
    uses: netresearch/typo3-ci-workflows/.github/workflows/publish-to-ter.yml@main
    permissions:
      contents: read
    secrets:
      TYPO3_EXTENSION_KEY: ${{ secrets.TYPO3_EXTENSION_KEY }}
      TYPO3_TER_ACCESS_TOKEN: ${{ secrets.TYPO3_TER_ACCESS_TOKEN }}

Input	Type	Default	Description
`php-version`	string	`8.4`	PHP version for tailor CLI

Secret	Required	Description
`TYPO3_EXTENSION_KEY`	Yes	Extension key registered in TER
`TYPO3_TER_ACCESS_TOKEN`	Yes	TER API access token

Automatically validates that the tag version matches ext_emconf.php before publishing.

Labeler

jobs:
  labeler:
    uses: netresearch/typo3-ci-workflows/.github/workflows/labeler.yml@main
    permissions:
      contents: read
      pull-requests: write

Input	Type	Default	Description
`configuration-path`	string	`.github/labeler.yml`	Path to the labeler configuration file

Lock Threads

jobs:
  lock:
    uses: netresearch/typo3-ci-workflows/.github/workflows/lock.yml@main
    permissions:
      issues: write
      pull-requests: write

Input	Type	Default	Description
`issue-inactive-days`	number	`365`	Days before locking inactive issues
`pr-inactive-days`	number	`365`	Days before locking inactive PRs
`issue-lock-reason`	string	`resolved`	Reason for locking issues
`pr-lock-reason`	string	`resolved`	Reason for locking PRs
`log-output`	boolean	`true`	Log processed threads

Greetings

jobs:
  greetings:
    uses: netresearch/typo3-ci-workflows/.github/workflows/greetings.yml@main
    permissions:
      issues: write
      pull-requests: write
    with:
      issue-message: 'Custom welcome message for issues'
      pr-message: 'Custom welcome message for PRs'

Input	Type	Default	Description
`issue-message`	string	Generic welcome	Message for first-time issue authors
`pr-message`	string	Generic welcome	Message for first-time PR authors

Documentation

jobs:
  docs:
    uses: netresearch/typo3-ci-workflows/.github/workflows/docs.yml@main
    permissions:
      contents: read

Input	Type	Default	Description
`source-path`	string	`Documentation`	Path to documentation source
`output-path`	string	`Documentation-GENERATED-temp`	Path for rendered output
`upload-artifact`	boolean	`true`	Upload rendered docs as artifact on PRs
`artifact-retention-days`	number	`7`	Days to retain uploaded artifact

Stale Issues

jobs:
  stale:
    uses: netresearch/typo3-ci-workflows/.github/workflows/stale.yml@main
    permissions:
      issues: write
      pull-requests: write

Input	Type	Default	Description
`days-before-stale`	number	`60`	Days before marking as stale
`days-before-close`	number	`7`	Days before closing stale issues
`exempt-issue-labels`	string	`pinned,security,bug`	Comma-separated labels to exempt
`exempt-pr-labels`	string	`pinned,security`	Comma-separated PR labels to exempt
`operations-per-run`	number	`30`	Max operations per run
`stale-issue-message`	string	Generic message	Message when marking issue as stale
`stale-pr-message`	string	Generic message	Message when marking PR as stale
`close-issue-message`	string	Generic message	Message when closing stale issue
`close-pr-message`	string	Generic message	Message when closing stale PR

Stale labels (stale) are hardcoded to stay within the 10-input workflow_call limit.

License Check

jobs:
  license-check:
    uses: netresearch/typo3-ci-workflows/.github/workflows/license-check.yml@main
    permissions:
      contents: read

Input	Type	Default	Description
`php-version`	string	`8.4`	PHP version for license checking
`forbidden-licenses`	string	`"(SSPL\|BSL)"`	Regex pattern for forbidden licenses

Fails the job (exit 1) when forbidden licenses are found, not just a warning.

Security

jobs:
  security:
    uses: netresearch/typo3-ci-workflows/.github/workflows/security.yml@main
    permissions:
      contents: read
      security-events: write
    secrets:
      GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE }}

Input	Type	Default	Description
`php-version`	string	`8.4`	PHP version for Composer audit
`skip-gitleaks`	boolean	`false`	Skip Gitleaks secret scanning
`skip-composer-audit`	boolean	`false`	Skip Composer dependency audit

Secret	Required	Description
`GITLEAKS_LICENSE`	No	License key for Gitleaks

Gitleaks automatically skips dependabot PRs and merge_group events.

PR Quality Gates

jobs:
  pr-quality:
    uses: netresearch/typo3-ci-workflows/.github/workflows/pr-quality.yml@main
    permissions:
      contents: read
      pull-requests: write

Input	Type	Default	Description
`size-warning-threshold`	number	`500`	Lines changed for medium size
`size-alert-threshold`	number	`1000`	Lines changed for large size warning
`security-controls-path`	string	`.github/SECURITY_CONTROLS.md`	Path to security controls docs

Includes two jobs: PR size check and auto-approve for solo maintainer projects. Skips draft PRs.

Release

jobs:
  release:
    uses: netresearch/typo3-ci-workflows/.github/workflows/release.yml@main
    permissions:
      contents: write
      id-token: write
      attestations: write
    with:
      archive-prefix: my-extension
      package-name: vendor/my-extension

Input	Type	Required	Default	Description
`archive-prefix`	string	yes	—	Prefix for archive files (e.g., `contexts`)
`package-name`	string	yes	—	Composer package name (e.g., `netresearch/contexts`)
`include-sbom`	boolean	no	`true`	Include SPDX and CycloneDX SBOMs
`sign-artifacts`	boolean	no	`true`	Sign artifacts with Cosign keyless signing

Full enterprise release pipeline: git archive, SBOM generation (SPDX + CycloneDX), SHA256 checksums, Cosign keyless signing, build provenance attestation, and GitHub Release with verification instructions.

Fuzzing

jobs:
  fuzz:
    uses: netresearch/typo3-ci-workflows/.github/workflows/fuzz.yml@main
    permissions:
      contents: read

Input	Type	Default	Description
`php-version`	string	`8.4`	PHP version for tests
`php-extensions`	string	`intl, mbstring, xml`	PHP extensions to install
`fuzz-testsuite`	string	`Fuzz`	PHPUnit testsuite name for fuzz tests
`phpunit-config`	string	`Build/phpunit.xml`	Path to PHPUnit config
`run-fuzz-tests`	boolean	`true`	Run fuzz tests
`run-mutation-tests`	boolean	`true`	Run mutation tests with Infection
`mutation-min-msi`	number	`50`	Minimum Mutation Score Indicator
`mutation-min-covered-msi`	number	`60`	Minimum Covered MSI

Mutation testing runs with continue-on-error: true to allow incremental threshold improvement.

SLSA Provenance

name: SLSA Provenance
on:
  workflow_run:
    workflows: ["Release"]
    types: [completed]
  workflow_dispatch:
    inputs:
      version:
        description: 'Release version tag (e.g. v4.0.0)'
        required: true
        type: string
permissions: {}
jobs:
  provenance:
    uses: netresearch/typo3-ci-workflows/.github/workflows/slsa-provenance.yml@main
    permissions:
      actions: read
      contents: write
      id-token: write
    with:
      version: ${{ inputs.version }}

Input	Type	Default	Description
`version`	string	auto-detect	Release version tag (auto-detected from workflow_run)
`artifact-patterns`	string	`.tar.gz .zip .spdx.json .cdx.json SHA256SUMS.txt checksums.txt`	Glob patterns for release assets

Generates SLSA Level 3 provenance using slsa-framework/slsa-github-generator. Triggered after the Release workflow completes. Uses compile-generator: true and private-repository: true workarounds for reliability.

Security

All third-party actions are SHA-pinned
step-security/harden-runner on every job
Top-level permissions: {} with job-level least-privilege
persist-credentials: false on all checkout steps
No ${{ }} expression interpolation in run: blocks
Randomized heredoc delimiters to prevent output injection
Timeout-minutes on every job

Name		Name	Last commit message	Last commit date
Latest commit History 42 Commits
.github/workflows		.github/workflows
config		config
docs/plans		docs/plans
scripts		scripts
.gitattributes		.gitattributes
Makefile.include		Makefile.include
README.md		README.md
composer.json		composer.json
renovate.json		renovate.json

Folders and files

Latest commit

History

Repository files navigation

typo3-ci-workflows

Workflows

Quick Start

CI Workflow Inputs

Matrix Configuration

Feature Flags

Custom Commands

PHP Extensions

Functional Tests

Coverage

Incompatible Dev Dependencies

Other Workflows

Scorecard

CodeQL

Dependency Review

Auto-merge Dependency PRs

Publish to TER

Labeler

Lock Threads

Greetings

Documentation

Stale Issues

License Check

Security

PR Quality Gates

Release

Fuzzing

SLSA Provenance

Security

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases 4

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Packages