File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content typex:	`text/markdown`
Description:	Documentation
Class:	PHP Project Template Generate files for PHP projects from templates
Author:	By Eric Sizemore
Last change:
Date:	9 months ago
Size:	`5,426 bytes`

Download

PHP Project Template

ericsizemore/php-project-template started as a template to be used for my own future repos/libraries, with the goal of eventually bringing my current repos to parity with this setup.

This package can be used to create a basic PHP library package/repository, complete with a directory structure and starting files (i.e. README, LICENSE, issue templates, PHPUnit configuration, etc.) commonly found in PHP libraries.

> [!WARNING] > > This project is not finished yet, work in progress.

Installation

You can install the package via composer:

$ composer create-project ericsizemore/php-project-template YOUR-PROJECT-NAME

You can also create a repository from this template on GitHub.

Workflow Setup

The continuous-integration.yml workflow expects the project to exist on Scrutinizer so that it can upload coverage reports. It also makes use of CodeCov, so it will require a new repository/action secret named CODECOV_TOKEN.

Renovate is used to handle automated updating of composer dependencies. A merge-me.yml workflow is provided to automatically merge PR's created by Renovate. This requires Allow auto-merge to be enabled in repository settings, and a new repository/action secret named MERGE_ME.

          # Create a token with repository permissions:
          # https://github.com/settings/tokens/new?scopes=repo&description=Merge+Me!+GitHub+Actions+Workflow
          #
          # Set MERGE_TOKEN as an environment variable on your repository:
          # https://github.com/yourname/repo-name/settings/secrets/actions/new

The mutation-test portion of the continuous-integration.yml workflow sends mutation coverage (handled with Infection) information to Stryker and requires a new repository/action secret named STRYKER_DASHBOARD_API_KEY.