From 73eca6c9e040722e97d97aa8448aa09334a74607 Mon Sep 17 00:00:00 2001 From: MGatner Date: Wed, 12 Jan 2022 21:15:30 +0000 Subject: [PATCH] Organize files --- README.md | 16 +++++++++++----- src/{ => Template}/.github/dependabot.yml | 0 src/{ => Template}/.github/workflows/deptrac.yml | 0 .../.github/workflows/infection.yml | 0 src/{ => Template}/.github/workflows/phpcpd.yml | 0 .../.github/workflows/phpcsfixer.yml | 0 src/{ => Template}/.github/workflows/phpstan.yml | 0 src/{ => Template}/.github/workflows/phpunit.yml | 0 src/{ => Template}/.github/workflows/rector.yml | 0 src/{ => Template}/.github/workflows/unused.yml | 0 src/{ => Template}/.php-cs-fixer.dist.php | 0 src/{ => Template}/depfile.yaml | 0 src/{ => Template}/infection.json.dist | 0 src/{ => Template}/phpstan.neon.dist | 0 src/{ => Template}/phpunit.xml.dist | 0 src/{ => Template}/rector.php | 0 16 files changed, 11 insertions(+), 5 deletions(-) rename src/{ => Template}/.github/dependabot.yml (100%) rename src/{ => Template}/.github/workflows/deptrac.yml (100%) rename src/{ => Template}/.github/workflows/infection.yml (100%) rename src/{ => Template}/.github/workflows/phpcpd.yml (100%) rename src/{ => Template}/.github/workflows/phpcsfixer.yml (100%) rename src/{ => Template}/.github/workflows/phpstan.yml (100%) rename src/{ => Template}/.github/workflows/phpunit.yml (100%) rename src/{ => Template}/.github/workflows/rector.yml (100%) rename src/{ => Template}/.github/workflows/unused.yml (100%) rename src/{ => Template}/.php-cs-fixer.dist.php (100%) rename src/{ => Template}/depfile.yaml (100%) rename src/{ => Template}/infection.json.dist (100%) rename src/{ => Template}/phpstan.neon.dist (100%) rename src/{ => Template}/phpunit.xml.dist (100%) rename src/{ => Template}/rector.php (100%) diff --git a/README.md b/README.md index 904b75e..94d1a10 100644 --- a/README.md +++ b/README.md @@ -41,10 +41,10 @@ locally they will need to be installed. All of them (except Rector) are availabl * [PHP CS Fixer](https://cs.symfony.com/) * [Rector](https://github.com/rectorphp/rector/) -## Source Files +## Template Files -The provided source files should be considered guidelines or templates for your own use, as -they may need changing to fit your environment. These are based on the following assumptions: +The provided source files (in **Template/**) should be considered guidelines for your own use, +as they may need changing to fit your environment. These are based on the following assumptions: 1. Your default repository branch is set to `develop` 2. You use Composer to manage all necessary dependencies @@ -56,7 +56,7 @@ they may need changing to fit your environment. These are based on the following This kit includes a number of workflow templates for integrating [GitHub Actions](https://docs.github.com/en/actions) into your library or project development process. To add these to your repo simply copy the -workflows into a **.github/workflows/** directory. +workflows into a **Template/.github/workflows/** directory. > Hint: the [source files](src/.github) also include a configuration for Dependabot which will help keep your dependencies and workflows updated. @@ -136,10 +136,16 @@ so be sure to read the documentation and figure out the best fit for you. This w a "dry run" to check for any changes that Rector would have made and fail if there are matches. > Note: Rector updates rules all the time so you may want to lock your repo to the latest known working version of Rector to prevent unexpected failures -> E.g. in **.github/workflows/rector.yml** supply the specific minor patch: `composer global require --dev rector/rector:0.12.4` +> E.g. in **Template/.github/workflows/rector.yml** supply the specific minor patch: `composer global require --dev rector/rector:0.12.4` #### Unused Composer Unused does one thing: checks that your code actually uses the dependencies you have included via Composer. It can be easy to forget to update your **composer.json** when your code drops a dependency, so this workflow will help track those down. + +## Example Files + +Besides the template files, this repo includes some examples for integrating CodeIgniter +with other third-party resources. These files (in **Examples/**) may change over time and +should not be relied on for anything more than a reference for your own code. diff --git a/src/.github/dependabot.yml b/src/Template/.github/dependabot.yml similarity index 100% rename from src/.github/dependabot.yml rename to src/Template/.github/dependabot.yml diff --git a/src/.github/workflows/deptrac.yml b/src/Template/.github/workflows/deptrac.yml similarity index 100% rename from src/.github/workflows/deptrac.yml rename to src/Template/.github/workflows/deptrac.yml diff --git a/src/.github/workflows/infection.yml b/src/Template/.github/workflows/infection.yml similarity index 100% rename from src/.github/workflows/infection.yml rename to src/Template/.github/workflows/infection.yml diff --git a/src/.github/workflows/phpcpd.yml b/src/Template/.github/workflows/phpcpd.yml similarity index 100% rename from src/.github/workflows/phpcpd.yml rename to src/Template/.github/workflows/phpcpd.yml diff --git a/src/.github/workflows/phpcsfixer.yml b/src/Template/.github/workflows/phpcsfixer.yml similarity index 100% rename from src/.github/workflows/phpcsfixer.yml rename to src/Template/.github/workflows/phpcsfixer.yml diff --git a/src/.github/workflows/phpstan.yml b/src/Template/.github/workflows/phpstan.yml similarity index 100% rename from src/.github/workflows/phpstan.yml rename to src/Template/.github/workflows/phpstan.yml diff --git a/src/.github/workflows/phpunit.yml b/src/Template/.github/workflows/phpunit.yml similarity index 100% rename from src/.github/workflows/phpunit.yml rename to src/Template/.github/workflows/phpunit.yml diff --git a/src/.github/workflows/rector.yml b/src/Template/.github/workflows/rector.yml similarity index 100% rename from src/.github/workflows/rector.yml rename to src/Template/.github/workflows/rector.yml diff --git a/src/.github/workflows/unused.yml b/src/Template/.github/workflows/unused.yml similarity index 100% rename from src/.github/workflows/unused.yml rename to src/Template/.github/workflows/unused.yml diff --git a/src/.php-cs-fixer.dist.php b/src/Template/.php-cs-fixer.dist.php similarity index 100% rename from src/.php-cs-fixer.dist.php rename to src/Template/.php-cs-fixer.dist.php diff --git a/src/depfile.yaml b/src/Template/depfile.yaml similarity index 100% rename from src/depfile.yaml rename to src/Template/depfile.yaml diff --git a/src/infection.json.dist b/src/Template/infection.json.dist similarity index 100% rename from src/infection.json.dist rename to src/Template/infection.json.dist diff --git a/src/phpstan.neon.dist b/src/Template/phpstan.neon.dist similarity index 100% rename from src/phpstan.neon.dist rename to src/Template/phpstan.neon.dist diff --git a/src/phpunit.xml.dist b/src/Template/phpunit.xml.dist similarity index 100% rename from src/phpunit.xml.dist rename to src/Template/phpunit.xml.dist diff --git a/src/rector.php b/src/Template/rector.php similarity index 100% rename from src/rector.php rename to src/Template/rector.php