Release/v0.1.1 (#120)

* fix(BodyData): Added default body data (#118)

* Update dependencies

* Add default value to body data

* feat(Migrations): Implemented db migrations (#119)

* Install doctrine migrations package

* Add migrations configuration

* Add migrations folder

* Update usefull commands

* Generates initial migration

* Load all migrations

* Update readme

* Update pr template

* Add foreign keys

* Rename workflow

* Move cache up

* Move checkout

* Bump version

Author: pchalupa

.github/pull_request_template.md

@@ -9,3 +9,4 @@ Describe your changes in detail.
 - [ ] Unit tests for the changes have been added
 - [ ] Static analysis exits without any error
 - [ ] CS Fix exits without any error
+- [ ] DB schema migration has been generated

.github/workflows/main.workflow.yml

@@ -2,14 +2,12 @@ name: Main workflow
 on:
    push:
 jobs:
-  ci:
+  main:
     runs-on: ubuntu-20.04
     env:
       DB_NAME: test
       DB_PASSWORD: root
     steps:
-    - uses: actions/checkout@v2
-
     - uses: shivammathur/setup-php@v2
       with:
         php-version: '7.4'
@@ -21,17 +19,15 @@ jobs:
         mysql database: ${{ env.DB_NAME }}
         mysql root password: ${{ env.DB_PASSWORD }}
 
-    - name: Install new instance
-      run: ./bin/install.sh root "$DB_PASSWORD" "$DB_NAME" 127.0.0.1 3306
+    - uses: actions/checkout@v2
 
-    - name: Cache Composer packages
-      id: composer-cache
-      uses: actions/cache@v2
+    - uses: actions/cache@v2
       with:
         path: vendor
         key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-php-
+
+    - name: Install new instance
+      run: ./bin/install.sh root "$DB_PASSWORD" "$DB_NAME" 127.0.0.1 3306
 
     - name: Validate DB schema
       run: composer orm:validate

README.md

@@ -2,52 +2,69 @@
 
 ## Instalation
 
-1. Clone repository: `git clone https://github.com/Stacha-dev/back-end.git && cd back-end`
+1. Clone repository: `git clone https://github.com/Stacha-dev/tardis.git && cd tardis`
 2. Run install script `./bin/install.sh <db_user> <db_password> <db_name>`
 3. Generate password for root user `composer app:password <password>`
 
 ## Development
 
 1. Update `git pull develop` to get recent commits
 2. Install composer dependencies `composer install`
-3. Reload DB schema `composer orm:drop` and then `composer orm:create`
-4. Create new branch by `git checkout -b <branch_name>`
-    - Feature `feat/<feature_name>`
-    - Bugfix `fix/<bugfix_name>`
-5. Commit changes to repository
+3. Load DB schema `composer migrations:migrate` and generate proxies `composer orm:proxies`
+4. Create new branch by `git checkout -b <branch-name>` follow this convention:
+    - Feature `feat/<feature-name>`
+    - Bugfix `fix/<bugfix-name>`
+    - Chore `chore/<chore-name>`
+5. Commit changes to the remote branch
 6. In case of feature add PHP Unit test suite
-6. Create pull request into `develop` branch
+6. Create pull request into `develop` branch follow this convention
+    - `<type>(Scope): Description` example: `feat(User): Added user model`
 
 ## API
 
 Endpoints: [POSTMAN](https://documenter.getpostman.com/view/10875200/T1LTdP9o?version=latest)
 
-## Usefull commands
+## Usefull Commands
 
 ### App
--   Generate password `composer app:password <password>`
+
+```
+composer app:password <password>    // Generates password
+```
 
 ### ORM
 
--   Create DB schema `composer orm:create`
--   Update DB schema`composer orm:update`
--   Drop  DB schema`composer orm:drop`
+```
+composer orm:create                 // Creates DB schema
+composer orm:update                 // Updates DB schema
+compsoer orm:drop                   // Drops DB schema
+```
 
-### Composer
+### Migrations
 
--   Install `composer require <package>`
--   Update `composer update`
--   Remove `composer remove <package>`
+```
+composer migrations:diff            // Generates differences in DB schema
+composer migrations:status          // Show migration status
+composer migrations:migrate         // Migrate to latest migration
+```
 
 ### PHPStan
 
--   Static analysis `composer phpstan`
+```
+composer phpstan                    // Runs static analysis
+```
+
+### Coding Standards
 
-### CS
+```
+composer cs                         // Checks coding standarts
+composer cs:fix                     // Fixes coding standarts
 
--   Check cs `composer cs:fix`
--   Fix cs `composer cs`
+```
 
 ### PHP Unit
--   Run all tests `composer test`
--   Generate test coverage `composer test:codecov`
+
+```
+composer test                       // Runs all unit tests
+compsoer test:coverage              // Generates test coverage
+```

bin/install.sh

@@ -25,7 +25,7 @@ generate_config config/common.ini > config/common.local.ini
 
 # ORM
 composer orm:drop
-composer orm:create
+composer migrations:migrate -- --no-interaction
 composer orm:proxies
 
 # Fixtures

composer.json

@@ -2,7 +2,7 @@
 	"name": "stacha/back-end",
 	"type": "project",
 	"description": "Back-end for our applications.",
-	"version": "0.1.0",
+	"version": "0.1.1",
 	"license": "MIT",
 	"authors": [
 		{
@@ -17,17 +17,18 @@
 		}
 	],
 	"require": {
+		"doctrine/data-fixtures": "^1.5",
+		"doctrine/migrations": "^3.1",
 		"doctrine/orm": "^2.7.3",
-		"firebase/php-jwt": "^5.2"
+		"firebase/php-jwt": "^5.2",
+		"symfony/console": "^5.2"
 	},
 	"require-dev": {
-		"doctrine/data-fixtures": "^1.4",
 		"friendsofphp/php-cs-fixer": "^2.16",
 		"phpdocumentor/graphviz": "^2.0@dev",
 		"phpdocumentor/phpdocumentor": "^3.0",
 		"phpstan/phpstan": "^0.12.25",
 		"phpunit/phpunit": "^8.5",
-		"symfony/console": "^5.2",
 		"symfony/finder": "5.1.*",
 		"symfony/process": "5.1.*",
 		"symfony/string": "5.1.*"
@@ -41,16 +42,20 @@
 		"sort-packages": true
 	},
 	"scripts": {
+		"app:password": "php bin/console app:password",
 		"docs": "phpdoc",
 		"test": "vendor/bin/phpunit tests",
 		"test:coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html public/reports/test-coverage/",
 		"orm:create": "doctrine orm:schema-tool:create",
-		"orm:update": "doctrine orm:clear-cache:metadata && doctrine orm:schema-tool:update --force",
+		"orm:update": "composer orm:clear-cache:metadata && doctrine orm:schema-tool:update --force",
 		"orm:drop": "doctrine orm:clear-cache:metadata && doctrine orm:schema-tool:drop --full-database  --force",
 		"orm:proxies": "doctrine orm:generate-proxies",
 		"orm:validate": "doctrine orm:validate-schema",
+		"orm:clear-cache:metadata": "doctrine orm:clear-cache:metadata",
 		"fixtures:load": "php bin/console fixtures:load",
-		"app:password": "php bin/console app:password",
+		"migrations:diff": "composer orm:clear-cache:metadata && doctrine-migrations migrations:diff",
+		"migrations:status": "doctrine-migrations migrations:status",
+		"migrations:migrate": "doctrine-migrations migrations:migrate",
 		"phpstan": "phpstan analyse",
 		"cs": "vendor/bin/php-cs-fixer fix src --dry-run --ansi",
 		"cs:fix": "vendor/bin/php-cs-fixer fix src --ansi"