feat: add automation, linting and improve DX #174
There are no files selected for viewing
This file contains hidden or 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,2 @@ | ||
| * | ||
| !.gitignore |
|
There was a problem hiding this comment.
|
This file contains hidden or 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
|
There was a problem hiding this comment. Developer now can edit .env.example using editor and then generate local
|
This file contains hidden or 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,21 @@ | ||
| # https://docs.docker.com/compose/reference/envvars/#compose_project_name | ||
| # With custom namespace provided, it will be used to prefix all services | ||
| # in Docker network for current project | ||
| COMPOSE_PROJECT_NAME=cycle-database | ||
| APP_ENV=production | ||
|
|
||
| DB_CONNECTION=pgsql | ||
| DB_HOST=pgsql | ||
| DB_PORT=5432 | ||
|
|
||
| DB_DATABASE=default | ||
| DB_USERNAME=root | ||
| DB_PASSWORD=password | ||
|
|
||
| DB_SQLSERVER_FORWARD_PORT=11433 | ||
| DB_MYSQL_FORWARD_PORT=13333 | ||
| DB_PGSQL_FORWARD_PORT=15333 | ||
|
|
||
| XDEBUG_MODE=coverage | ||
|
|
||
| GITHUB_TOKEN=ghp_ |
|
There was a problem hiding this comment. Production composer package, that is bundled by GitHub, should only contain production files, |
This file contains hidden or 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 |
|---|---|---|
| @@ -1,5 +1,15 @@ | ||
| /.build export-ignore | ||
| /.github export-ignore | ||
| /tests export-ignore | ||
| .editorconfig export-ignore | ||
| .env.example export-ignore | ||
| .gitattributes export-ignore | ||
| .gitignore export-ignore | ||
| .php-cs-fixer.dist.php export-ignore | ||
| .scrutinizer.yml export-ignore | ||
| .styleci.yml export-ignore | ||
| docker-compose.yaml export-ignore | ||
| infection.json.dist export-ignore | ||
| Makefile export-ignore | ||
| phpunit.xml export-ignore | ||
| psalm.xml export-ignore |
This file contains hidden or 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,72 @@ | ||
| { | ||
| "release-type": "node", | ||
| "packages": { | ||
| ".": { | ||
| "package-name": "database", | ||
| "changelog-path": "/CHANGELOG.md" | ||
| } | ||
| }, | ||
| "include-component-in-tag": false, | ||
| "changelog-sections": [ | ||
| { | ||
| "type": "feat", | ||
| "section": "Features", | ||
| "hidden": false | ||
| }, | ||
| { | ||
| "type": "fix", | ||
| "section": "Bug Fixes", | ||
| "hidden": false | ||
| }, | ||
| { | ||
| "type": "perf", | ||
| "section": "Performance Improvements", | ||
| "hidden": false | ||
| }, | ||
| { | ||
| "type": "docs", | ||
| "section": "Documentation", | ||
| "hidden": false | ||
| }, | ||
| { | ||
| "type": "chore", | ||
| "section": "Miscellaneous", | ||
| "hidden": false | ||
| }, | ||
| { | ||
| "type": "style", | ||
| "section": "Styles", | ||
| "hidden": true | ||
| }, | ||
| { | ||
| "type": "revert", | ||
| "section": "Reverts", | ||
| "hidden": true | ||
| }, | ||
| { | ||
| "type": "deps", | ||
| "section": "Dependencies", | ||
| "hidden": false | ||
| }, | ||
| { | ||
| "type": "refactor", | ||
| "section": "Code Refactoring", | ||
| "hidden": false | ||
| }, | ||
| { | ||
| "type": "test", | ||
| "section": "Tests", | ||
| "hidden": true | ||
| }, | ||
| { | ||
| "type": "build", | ||
| "section": "Build System", | ||
| "hidden": true | ||
| }, | ||
| { | ||
| "type": "ci", | ||
| "section": "Continuous Integration", | ||
| "hidden": true | ||
| } | ||
| ] | ||
| } |
This file contains hidden or 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,3 @@ | ||
| { | ||
| ".": "3.0.0" | ||
| } |
|
There was a problem hiding this comment. Moved |
File renamed without changes.
|
There was a problem hiding this comment. Added github action to automatically generate changelog PR's from developer commits.
|
This file contains hidden or 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,26 @@ | ||
| --- | ||
|
|
||
| # https://github.com/wayofdev/gh-actions/blob/master/.github/workflows/create-release.yml | ||
| # https://github.com/google-github-actions/release-please-action#release-types-supported | ||
|
|
||
| on: # yamllint disable-line rule:truthy | ||
| push: | ||
| branches: | ||
| - master | ||
|
|
||
| name: 📦 Create release | ||
|
|
||
| jobs: | ||
| release: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: 🎉 Create release | ||
| uses: google-github-actions/release-please-action@v4 | ||
| id: release | ||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| config-file: .github/.release-please-config.json | ||
| manifest-file: .github/.release-please-manifest.json | ||
| target-branch: 2.x | ||
|
|
||
| ... |
This file contains hidden or 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
|
There was a problem hiding this comment. 🚀 Introducing wayofdev/php-cs-fixer-config This package serves as a comprehensive wrapper around Key Features:
Example:<?php
declare(strict_types=1);
namespace WayOfDev\Cycle\Bridge\Laravel\Console\Commands\Migrations;
use Cycle\Migrations\Config\MigrationConfig;
use Cycle\Migrations\Migrator;
use Illuminate\Console\Command;
use Symfony\Component\Console\Input\InputOption;
use function array_merge;
use function call_user_func_array;
abstract class AbstractCommand extends Command
{Enhanced Developer Flexibility:
Configuration Highlights:The configuration extends the Symfony rule set with customized overrides for a tailored coding standard. Key adjustments include:
|
This file contains hidden or 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,20 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| use WayOfDev\PhpCsFixer\Config\ConfigBuilder; | ||
| use WayOfDev\PhpCsFixer\Config\RuleSets\DefaultSet; | ||
|
|
||
| require_once 'vendor/autoload.php'; | ||
|
|
||
| $config = ConfigBuilder::createFromRuleSet(new DefaultSet(['static_lambda' => false])) | ||
| ->inDir(__DIR__ . '/resources') | ||
| ->inDir(__DIR__ . '/src') | ||
| ->inDir(__DIR__ . '/tests') | ||
| ->addFiles([__FILE__]) | ||
| ->getConfig() | ||
| ; | ||
|
|
||
| $config->setCacheFile(__DIR__ . '/.build/php-cs-fixer/php-cs-fixer.cache'); | ||
|
|
||
| return $config; |
|
There was a problem hiding this comment. I've integrated the pre-commit framework into our repository to enhance code quality and efficiency. This tool runs checks locally before a pull request is made, aiming to:
The adoption of pre-commit is a strategic move to maintain high code standards while optimizing the review process. |
This file contains hidden or 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,23 @@ | ||
| --- | ||
|
|
||
| repos: | ||
| - repo: https://github.com/pre-commit/pre-commit-hooks | ||
| rev: v4.5.0 | ||
| hooks: | ||
| - id: check-executables-have-shebangs | ||
| - id: check-shebang-scripts-are-executable | ||
| - id: check-json | ||
| - id: trailing-whitespace | ||
| - id: end-of-file-fixer | ||
| - id: check-added-large-files | ||
| args: ['--maxkb=600'] | ||
| - id: fix-encoding-pragma | ||
|
|
||
| - repo: https://github.com/commitizen-tools/commitizen | ||
| rev: v3.20.0 | ||
| hooks: | ||
| - id: commitizen | ||
| stages: | ||
| - commit-msg | ||
|
|
||
| ... |
|
There was a problem hiding this comment. I've added yamllint to our repository for YAML file validation. It ensures:
This integration streamlines development by automating YAML checks, enhancing code quality and consistency. |
This file contains hidden or 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,56 @@ | ||
| --- | ||
|
|
||
| extends: default | ||
|
|
||
| ignore: | | ||
| .build/ | ||
| vendor/ | ||
|
|
||
| # Overwrite above default rules | ||
| rules: | ||
| braces: | ||
| # Defaults | ||
| # min-spaces-inside: 0 | ||
| # max-spaces-inside: 0 | ||
|
|
||
| # Keep 0 min-spaces to not error on empty {} collection definitions | ||
| min-spaces-inside: 0 | ||
|
|
||
| # Allow one space inside braces to improve code readability | ||
| max-spaces-inside: 1 | ||
|
|
||
| brackets: | ||
| # Defaults | ||
| # min-spaces-inside: 0 | ||
| # max-spaces-inside: 0 | ||
|
|
||
| # Keep 0 min-spaces to not error on empty [] collection definitions | ||
| min-spaces-inside: 0 | ||
|
|
||
| # Allow one space inside braces to improve code readability | ||
| max-spaces-inside: 1 | ||
|
|
||
| colons: | ||
| # Defaults | ||
| # min-spaces-before: 0 | ||
| # max-spaces-after: 1 | ||
|
|
||
| # Allow multiple spaces after a colon to allow indentation of YAML | ||
| # dictionary values | ||
| max-spaces-after: -1 | ||
|
|
||
| commas: | ||
| # Defaults | ||
| # max-spaces-after: 1 | ||
|
|
||
| # Allow multiple spaces after a comma to allow indentation of YAML | ||
| # dictionary values | ||
| max-spaces-after: -1 | ||
|
|
||
| comments: | ||
| require-starting-space: true | ||
| min-spaces-from-content: 1 | ||
|
|
||
| line-length: disable | ||
|
|
||
| ... |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Introduced a
.builddirectory to consolidatepsalm,php-cs-fixer, andphpunitcache files into a single location. This change declutters the local development environment and enables GitHub Actions to efficiently cache the.buildfolder, streamlining the workflow.