Skip to content

Commit c06a4ee

Browse files
committed
Update file
1 parent 802050b commit c06a4ee

File tree

4 files changed

+40
-97
lines changed

4 files changed

+40
-97
lines changed

README.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,16 @@ composer require yiisoft/db-mysql
4747

4848
English:
4949

50-
- For config connection to Mysql, MariaDb database check [Connecting MySQL/MariaDb](https://github.com/yiisoft/db/blob/master/docs/en/connection/mysql.md)
51-
- [Check the documentation](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage
50+
- For config connection to Mysql, MariaDb database check [Connecting MySQL/MariaDb](https://github.com/yiisoft/db/blob/master/docs/en/connection/mysql.md).
51+
- [Check the documentation](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage.
5252

5353
Portuguese - Brazil:
5454

55-
- For config connection to Mysql, MariaDb database check [Connecting MySQL/MariaDb](https://github.com/yiisoft/db/blob/master/docs/pt-BR/connection/mysql.md)
56-
- [Check the documentation](https://github.com/yiisoft/db/blob/master/docs/pt-BR/README.md) to learn about usage
55+
- Para configurar a conexão com Mysql, MariaDb leia [Connecting MySQL/MariaDb](https://github.com/yiisoft/db/blob/master/docs/pt-BR/connection/mysql.md).
56+
- [Confira a documentação](https://github.com/yiisoft/db/blob/master/docs/pt-BR/README.md) para aprender como usar.
5757

5858
Testing:
5959

60-
- [English](docs/guide/en/testing.md)
61-
- [Portuguese - Brazil](docs/guide/pt-BR/testing.md)
6260
- More information can be found in the [Internals.](docs/internals.md)
6361

6462
## Support
@@ -80,7 +78,7 @@ You may also check out other [Yii Community Resources](https://www.yiiframework.
8078

8179
## License
8280

83-
The Yii Access is free software. It is released under the terms of the BSD License.
81+
The Yii DataBase Mysql, MariaDb Extension is free software. It is released under the terms of the BSD License.
8482
Please see [`LICENSE`](./LICENSE.md) for more information.
8583

8684
Maintained by [Yii Software](https://www.yiiframework.com/).

docs/guide/en/testing.md

-44
This file was deleted.

docs/guide/pt-BR/testing.md

-44
This file was deleted.

docs/internals.md

+35-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,44 @@
11
# Internals
22

3+
## Github actions
4+
5+
All our packages have github actions by default, so you can test your [contribution](https://github.com/yiisoft/db-mysql/blob/master/.github/CONTRIBUTING.md) in the cloud.
6+
7+
> Note: We recommend pull requesting in draft mode until all tests pass.
8+
9+
## Docker image
10+
11+
For greater ease it is recommended to use docker containers, for this you can use the [docker-compose.yml](https://docs.docker.com/compose/compose-file/) file that is in the docs folder.
12+
13+
1. [MySQL 8](../../../docker-compose.yml)
14+
2. [MariaDB 10.11](../../../docker-compose-mariadb.yml)
15+
16+
For running the docker containers you can use the following command:
17+
18+
MySQL 8.0.
19+
20+
```dockerfile
21+
docker compose up -d
22+
```
23+
24+
MariaDB 10.11.
25+
26+
```dockerfile
27+
docker compose -f docker-compose-mariadb.yml up -d
28+
```
29+
330
## Unit testing
431

5-
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
32+
The package is tested with [PHPUnit](https://phpunit.de/).
33+
34+
The following steps are required to run the tests:
35+
36+
1. Run the docker container for the dbms.
37+
2. Install the dependencies of the project with composer.
38+
3. Run the tests.
639

740
```shell
8-
./vendor/bin/phpunit
41+
vendor/bin/phpunit
942
```
1043

1144
## Mutation testing

0 commit comments

Comments
 (0)