Skip to content

Commit 36c99e9

Browse files
authored
Merge pull request #38: Prepare to release
2 parents 69358b3 + cc11088 commit 36c99e9

58 files changed

Lines changed: 3886 additions & 6449 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
/tests export-ignore
33
/*.xml export-ignore
44
/*.yml export-ignore
5+
/*.yaml export-ignore
56
/*.lock export-ignore
67
/*.dist export-ignore

.github/.yamllint.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
extends: default
44

55
ignore: |
6-
.build/
6+
runtime/
77
vendor/
88
docs/
99

.github/CONTRIBUTING.md

Lines changed: 10 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,6 @@ We use a dockerized environment. Follow these steps to start working with the pr
8383
make env
8484
```
8585

86-
3. **Install phive and composer dependencies:**
87-
88-
```bash
89-
make phive
90-
make install
91-
```
92-
93-
<br>
94-
9586
## 🔧 Using the Makefile
9687

9788
This project uses a Makefile to streamline common development tasks. The Makefile includes utilities for managing Docker environments, installing project dependencies, running tests, and linting code.
@@ -156,7 +147,7 @@ $ make ssh
156147
$ make down
157148
```
158149

159-
By default, phpunit and phpstan commands will be ran against docker environment.
150+
By default, phpunit commands will be ran against docker environment.
160151

161152
<br>
162153

@@ -173,7 +164,7 @@ Our project employs [GitHub Actions](https://github.com/features/actions) for co
173164
| [`refactoring.yml`](workflows/refactoring.yml) | Runs rector/rector code check. |
174165
| [`security-analysis.yml`](workflows/security-analysis.yml) | Checks for security issues. |
175166
| [`shellcheck.yml`](workflows/shellcheck.yml) | Checks shell scripts. |
176-
| [`static-analysis.yml`](workflows/static-analysis.yml) | Runs `psalm` and `phpstan` tools. |
167+
| [`static-analysis.yml`](workflows/static-analysis.yml) | Runs `psalm`. |
177168
| [`testing.yml`](workflows/testing.yml) | Runs coverage, mutation and functional tests against SQLite |
178169
| [`testing-mysql.yml`](workflows/testing.yml) | Runs functional tests against MySQL |
179170
| [`testing-pgsql.yml`](workflows/testing.yml) | Runs functional tests against PostgreSQL |
@@ -184,7 +175,7 @@ Our project employs [GitHub Actions](https://github.com/features/actions) for co
184175
## 📝 Before You Contribute
185176

186177
* **Tests**: Include tests that cover any new features or bug fixes.
187-
* **Code Quality**: Utilize `make lint` for code style checks and `make lint-stan lint-psalm` for static analysis with [PHPStan](https://phpstan.org) and [Psalm](https://psalm.dev/).
178+
* **Code Quality**: Utilize `make lint` for code style checks and `make lint-stan lint-psalm` for static analysis with [Psalm](https://psalm.dev/).
188179
* **Documentation**: Update relevant documentation to reflect your changes, ensuring other developers can understand and use your contributions effectively.
189180
* **Commits**: use Conventional Commits standard to create a commit
190181

@@ -221,16 +212,6 @@ git commit -am 'fix: something has been fixed'
221212

222213
<br>
223214

224-
## 📦 PHAR Dependencies
225-
226-
We use [Phive](https://phar.io/) to manage PHAR dependencies. You can install all dependencies using the `make phive` command, which will be executed through the Docker environment.
227-
228-
```bash
229-
make phive
230-
```
231-
232-
<br>
233-
234215
## 🔍 Coding Standards
235216

236217
We enforce coding standards to maintain high code quality and readability. Here's a list of tools we use:
@@ -348,30 +329,25 @@ to run mutation tests.
348329

349330
## 🔍 Static Code Analysis
350331

351-
We use both [`phpstan/phpstan`](https://github.com/phpstan/phpstan) and [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code.
332+
We use [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code.
352333

353334
Run
354335

355336
```bash
356-
make lint-stan
357337
make lint-psalm
358338
```
359339

360340
to run a static code analysis.
361341

362-
We also use the baseline features of [`phpstan/phpstan`](https://phpstan.org/user-guide/baseline) and [`vimeo/psalm`](https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#using-a-baseline-file) to ignore existing issues.
342+
We also use the baseline features of [`vimeo/psalm`](https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#using-a-baseline-file) to ignore existing issues.
363343

364344
Run
365345

366346
```bash
367-
make lint-stan-baseline
368347
make lint-psalm-baseline
369348
```
370349

371-
to regenerate the baselines in:
372-
373-
* [`../phpstan-baseline.neon`](../phpstan-baseline.neon).
374-
* [`../psalm-baseline.xml`](../psalm-baseline.xml).
350+
to regenerate the baselines in [`../psalm-baseline.xml`](../psalm-baseline.xml).
375351

376352
> [!IMPORTANT]
377353
>
@@ -381,18 +357,18 @@ to regenerate the baselines in:
381357

382358
## 🧪 Unit and Functional Tests
383359

384-
We use [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) and [`pestphp/pest`](https://github.com/pestphp/pest) to drive the development.
360+
We use [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) to drive the development.
385361

386362
Run to run all the tests:
387363

388364
```bash
389-
# To run both, arch (pest) and unit (phpunit) tests
365+
# To run both, all the tests
390366
make test
391367

392-
# To run only arch (pest) tests
368+
# To run only arch tests
393369
make test-arch
394370

395-
# To run only unit (phpunit) tests
371+
# To run only unit tests
396372
make test-unit
397373
```
398374

.github/assets/screenshot.png

-1.3 MB
Binary file not shown.

.github/workflows/coding-standards.yml

Lines changed: 0 additions & 204 deletions
This file was deleted.

.github/workflows/cs-fix.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
3+
on: # yamllint disable-line rule:truthy
4+
push:
5+
branches:
6+
- '*'
7+
8+
name: Fix Code Style
9+
10+
jobs:
11+
cs-fix:
12+
permissions:
13+
contents: write
14+
uses: spiral/gh-actions/.github/workflows/cs-fix.yml@master
15+
16+
...

0 commit comments

Comments
 (0)