From 6ad4153842b384df9fa9906567abb8d54bd3214f Mon Sep 17 00:00:00 2001 From: Samantha Nguyen Date: Mon, 9 Dec 2024 18:02:05 -0600 Subject: [PATCH 1/3] ci: support running against PHP 8.4 --- .github/workflows/php.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml index eb092f6..b574ded 100644 --- a/.github/workflows/php.yml +++ b/.github/workflows/php.yml @@ -12,9 +12,10 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - php: + php: - '8.2' - '8.3' + - '8.4' steps: - name: Checkout repository From f39bfbf3790f690ea8cc22255ede59bd16156617 Mon Sep 17 00:00:00 2001 From: Samantha Nguyen Date: Mon, 9 Dec 2024 18:03:42 -0600 Subject: [PATCH 2/3] run against any pr branch --- .github/workflows/php.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml index b574ded..45fbcab 100644 --- a/.github/workflows/php.yml +++ b/.github/workflows/php.yml @@ -5,7 +5,6 @@ on: push: branches: [ main ] pull_request: - branches: [ main ] jobs: build: From 38a9686d447cd9e8670eb919812d7dcbb0d1af8b Mon Sep 17 00:00:00 2001 From: Samantha Nguyen Date: Mon, 9 Dec 2024 18:12:05 -0600 Subject: [PATCH 3/3] minor cleanup --- README.md | 28 ++++++++++------------------ 1 file changed, 10 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 6e036a4..c28f956 100644 --- a/README.md +++ b/README.md @@ -22,25 +22,17 @@ This repository makes it easier to develop a PHP application or library by provi ## Getting started ### Creating a new repository +Choose a method: +- **GitHub UI**: Press the "Use this template" button in the top-right corner of this page. +- **GitHub CLI**: Install [GitHub CLI](https://cli.github.com). Then run one of the following: + ```shell + gh repo create --template neoncitylights/php --public --clone {{repository}} # clone as public + gh repo create --template neoncitylights/php --private --clone {{repository}} # clone as private + ``` -#### GitHub UI +### Replace placeholders -You can create a new repository based on this template by clicking the "Use this template" button in the top-right corner of this page. - -#### Terminal - -You can run the following command below with the [GitHub CLI](https://cli.github.com/). Some notes: - -- Replace placeholder with name of your extension in upper CamelCase -- Configure your repository's visibility with `--public`, `--private`, or `--internal` - -```shell -gh repo create {repo-name} --public --clone --template neoncitylights/php-template -``` - -### Cookiecutter stuff - -Using your favorite text editor or IDE, find-and-replace the following placeholders: +Using your text editor or IDE, find-and-replace the following placeholders: - `{repo-name}`: Replace with the name of your repository - `author/package`: Replace with your own author and package name. @@ -56,7 +48,7 @@ Delete this `README.md`, and rename [`LIBRARY.md`](./LIBRARY.md) to `README.md`. | ---- | ---- | ------------- | | Composer package | [`composer.json`](./composer.json) | [docs](https://getcomposer.org/doc/04-schema.md), [website](https://getcomposer.org/), [repo](https://github.com/composer/composer) | | PHPCS (formatter + linter) | [`.phpcs.xml`](./.phpcs.xml) | [docs](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#using-a-default-configuration-file), [repo](https://github.com/squizlabs/PHP_CodeSniffer) | -| PHPUnit (unit testing) | [`.phpunit.xml.dist`](./.phpunit.xml.dist) | [docs](https://phpunit.readthedocs.io/en/10.1/configuration.html), [website](https://phpunit.de/), [repo](https://github.com/sebastianbergmann/phpunit) | +| PHPUnit (unit testing) | [`.phpunit.xml.dist`](./.phpunit.xml.dist) | [docs](https://phpunit.readthedocs.io/en/11.5/configuration.html), [website](https://phpunit.de/), [repo](https://github.com/sebastianbergmann/phpunit) | | phpdoc (documentation generator) | [`phpdoc.dist.xml`](./phpdoc.dist.xml) | [docs](https://docs.phpdoc.org/3.0/guide/references/configuration.html), [website](https://www.phpdoc.org/), [repo](https://github.com/phpdocumentor/phpdocumentor) | | Dependabot | [`.github/dependabot.yml`](./.github/dependabot.yml) | [docs](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file), [website](https://github.com/dependabot) |