forked from BitBagCommerce/SyliusVueStorefront2Plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial commit, fork Sylius PluginSkeleton v1.10
- Loading branch information
0 parents
commit 0110135
Showing
133 changed files
with
2,614 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* @Sylius/core-team |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,189 @@ | ||
name: Build | ||
|
||
on: | ||
push: | ||
branches-ignore: | ||
- 'dependabot/**' | ||
pull_request: ~ | ||
release: | ||
types: [created] | ||
schedule: | ||
- | ||
cron: "0 1 * * 6" # Run at 1am every Saturday | ||
workflow_dispatch: ~ | ||
|
||
jobs: | ||
tests: | ||
runs-on: ubuntu-18.04 | ||
|
||
name: "Sylius ${{ matrix.sylius }}, PHP ${{ matrix.php }}, Symfony ${{ matrix.symfony }}, MySQL ${{ matrix.mysql }}" | ||
|
||
strategy: | ||
fail-fast: false | ||
matrix: | ||
php: ["8.0", "7.4"] | ||
symfony: ["^4.4", "^5.2"] | ||
sylius: ["~1.9.0", "~1.10.0@alpha"] | ||
node: ["10.x"] | ||
mysql: ["8.0"] | ||
|
||
exclude: | ||
- | ||
php: "8.0" | ||
sylius: "~1.9.0" | ||
|
||
|
||
env: | ||
APP_ENV: test | ||
DATABASE_URL: "mysql://root:[email protected]/sylius?serverVersion=${{ matrix.mysql }}" | ||
|
||
steps: | ||
- | ||
uses: actions/checkout@v2 | ||
|
||
- | ||
name: Setup PHP | ||
uses: shivammathur/setup-php@v2 | ||
with: | ||
php-version: "${{ matrix.php }}" | ||
extensions: intl | ||
tools: symfony | ||
coverage: none | ||
|
||
- | ||
name: Setup Node | ||
uses: actions/setup-node@v1 | ||
with: | ||
node-version: "${{ matrix.node }}" | ||
|
||
- | ||
name: Shutdown default MySQL | ||
run: sudo service mysql stop | ||
|
||
- | ||
name: Setup MySQL | ||
uses: mirromutth/[email protected] | ||
with: | ||
mysql version: "${{ matrix.mysql }}" | ||
mysql root password: "root" | ||
|
||
- | ||
name: Output PHP version for Symfony CLI | ||
run: php -v | head -n 1 | awk '{ print $2 }' > .php-version | ||
|
||
- | ||
name: Install certificates | ||
run: symfony server:ca:install | ||
|
||
- | ||
name: Run Chrome Headless | ||
run: google-chrome-stable --enable-automation --disable-background-networking --no-default-browser-check --no-first-run --disable-popup-blocking --disable-default-apps --allow-insecure-localhost --disable-translate --disable-extensions --no-sandbox --enable-features=Metal --headless --remote-debugging-port=9222 --window-size=2880,1800 --proxy-server='direct://' --proxy-bypass-list='*' http://127.0.0.1 > /dev/null 2>&1 & | ||
|
||
- | ||
name: Run webserver | ||
run: (cd tests/Application && symfony server:start --port=8080 --dir=public --daemon) | ||
|
||
- | ||
name: Get Composer cache directory | ||
id: composer-cache | ||
run: echo "::set-output name=dir::$(composer config cache-files-dir)" | ||
|
||
- | ||
name: Cache Composer | ||
uses: actions/cache@v2 | ||
with: | ||
path: ${{ steps.composer-cache.outputs.dir }} | ||
key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.json **/composer.lock') }} | ||
restore-keys: | | ||
${{ runner.os }}-php-${{ matrix.php }}-composer- | ||
- | ||
name: Restrict Symfony version | ||
if: matrix.symfony != '' | ||
run: | | ||
composer global require --no-progress --no-scripts --no-plugins "symfony/flex:^1.10" | ||
composer config extra.symfony.require "${{ matrix.symfony }}" | ||
- | ||
name: Restrict Sylius version | ||
if: matrix.sylius != '' | ||
run: composer require "sylius/sylius:${{ matrix.sylius }}" --no-update --no-scripts --no-interaction | ||
|
||
- | ||
name: Install PHP dependencies | ||
run: composer install --no-interaction | ||
|
||
- | ||
name: Get Yarn cache directory | ||
id: yarn-cache | ||
run: echo "::set-output name=dir::$(yarn cache dir)" | ||
|
||
- | ||
name: Cache Yarn | ||
uses: actions/cache@v2 | ||
with: | ||
path: ${{ steps.yarn-cache.outputs.dir }} | ||
key: ${{ runner.os }}-node-${{ matrix.node }}-yarn-${{ hashFiles('**/package.json **/yarn.lock') }} | ||
restore-keys: | | ||
${{ runner.os }}-node-${{ matrix.node }}-yarn- | ||
- | ||
name: Install JS dependencies | ||
run: (cd tests/Application && yarn install) | ||
|
||
- | ||
name: Prepare test application database | ||
run: | | ||
(cd tests/Application && bin/console doctrine:database:create -vvv) | ||
(cd tests/Application && bin/console doctrine:schema:create -vvv) | ||
- | ||
name: Prepare test application assets | ||
run: | | ||
(cd tests/Application && bin/console assets:install public -vvv) | ||
(cd tests/Application && yarn build) | ||
- | ||
name: Prepare test application cache | ||
run: (cd tests/Application && bin/console cache:warmup -vvv) | ||
|
||
- | ||
name: Load fixtures in test application | ||
run: (cd tests/Application && bin/console sylius:fixtures:load -n) | ||
|
||
- | ||
name: Validate composer.json | ||
run: composer validate --ansi --strict | ||
|
||
- | ||
name: Validate database schema | ||
run: (cd tests/Application && bin/console doctrine:schema:validate) | ||
|
||
- | ||
name: Run PHPStan | ||
run: vendor/bin/phpstan analyse -c phpstan.neon -l max src/ | ||
|
||
- | ||
name: Run Psalm | ||
run: vendor/bin/psalm | ||
|
||
- | ||
name: Run PHPSpec | ||
run: vendor/bin/phpspec run --ansi -f progress --no-interaction | ||
|
||
- | ||
name: Run PHPUnit | ||
run: vendor/bin/phpunit --colors=always | ||
|
||
- | ||
name: Run Behat | ||
run: vendor/bin/behat --colors --strict -vvv --no-interaction || vendor/bin/behat --colors --strict -vvv --no-interaction --rerun | ||
|
||
- | ||
name: Upload Behat logs | ||
uses: actions/upload-artifact@v2 | ||
if: failure() | ||
with: | ||
name: Behat logs | ||
path: etc/build/ | ||
if-no-files-found: ignore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
/vendor/ | ||
/node_modules/ | ||
/composer.lock | ||
|
||
/etc/build/* | ||
!/etc/build/.gitignore | ||
|
||
/tests/Application/yarn.lock | ||
|
||
/.phpunit.result.cache | ||
/behat.yml | ||
/phpspec.yml | ||
/phpunit.xml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
<p align="center"> | ||
<a href="https://sylius.com" target="_blank"> | ||
<img src="https://demo.sylius.com/assets/shop/img/logo.png" /> | ||
</a> | ||
</p> | ||
|
||
<h1 align="center">Plugin Skeleton</h1> | ||
|
||
<p align="center">Skeleton for starting Sylius plugins.</p> | ||
|
||
## Documentation | ||
|
||
For a comprehensive guide on Sylius Plugins development please go to Sylius documentation, | ||
there you will find the <a href="https://docs.sylius.com/en/latest/plugin-development-guide/index.html">Plugin Development Guide</a>, that is full of examples. | ||
|
||
## Quickstart Installation | ||
|
||
1. Run `composer create-project sylius/plugin-skeleton ProjectName`. | ||
|
||
2. From the plugin skeleton root directory, run the following commands: | ||
|
||
```bash | ||
$ (cd tests/Application && yarn install) | ||
$ (cd tests/Application && yarn build) | ||
$ (cd tests/Application && APP_ENV=test bin/console assets:install public) | ||
|
||
$ (cd tests/Application && APP_ENV=test bin/console doctrine:database:create) | ||
$ (cd tests/Application && APP_ENV=test bin/console doctrine:schema:create) | ||
``` | ||
|
||
To be able to setup a plugin's database, remember to configure you database credentials in `tests/Application/.env` and `tests/Application/.env.test`. | ||
## Usage | ||
### Running plugin tests | ||
- PHPUnit | ||
```bash | ||
vendor/bin/phpunit | ||
``` | ||
- PHPSpec | ||
```bash | ||
vendor/bin/phpspec run | ||
``` | ||
- Behat (non-JS scenarios) | ||
```bash | ||
vendor/bin/behat --strict --tags="~@javascript" | ||
``` | ||
- Behat (JS scenarios) | ||
1. [Install Symfony CLI command](https://symfony.com/download). | ||
2. Start Headless Chrome: | ||
```bash | ||
google-chrome-stable --enable-automation --disable-background-networking --no-default-browser-check --no-first-run --disable-popup-blocking --disable-default-apps --allow-insecure-localhost --disable-translate --disable-extensions --no-sandbox --enable-features=Metal --headless --remote-debugging-port=9222 --window-size=2880,1800 --proxy-server='direct://' --proxy-bypass-list='*' http://127.0.0.1 | ||
``` | ||
3. Install SSL certificates (only once needed) and run test application's webserver on `127.0.0.1:8080`: | ||
|
||
```bash | ||
symfony server:ca:install | ||
APP_ENV=test symfony server:start --port=8080 --dir=tests/Application/public --daemon | ||
``` | ||
|
||
4. Run Behat: | ||
|
||
```bash | ||
vendor/bin/behat --strict --tags="@javascript" | ||
``` | ||
|
||
- Static Analysis | ||
|
||
- Psalm | ||
|
||
```bash | ||
vendor/bin/psalm | ||
``` | ||
|
||
- PHPStan | ||
|
||
```bash | ||
vendor/bin/phpstan analyse -c phpstan.neon -l max src/ | ||
``` | ||
|
||
- Coding Standard | ||
|
||
```bash | ||
vendor/bin/ecs check src | ||
``` | ||
|
||
### Opening Sylius with your plugin | ||
|
||
- Using `test` environment: | ||
|
||
```bash | ||
(cd tests/Application && APP_ENV=test bin/console sylius:fixtures:load) | ||
(cd tests/Application && APP_ENV=test bin/console server:run -d public) | ||
``` | ||
|
||
- Using `dev` environment: | ||
|
||
```bash | ||
(cd tests/Application && APP_ENV=dev bin/console sylius:fixtures:load) | ||
(cd tests/Application && APP_ENV=dev bin/console server:run -d public) | ||
``` |
Oops, something went wrong.