-
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs folder standardization and other fixes
- Loading branch information
1 parent
98c699a
commit 6a7e145
Showing
5 changed files
with
90 additions
and
39 deletions.
There are no files selected for viewing
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
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
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,35 @@ | ||
# Testing | ||
|
||
## Github actions | ||
|
||
All our packages have github actions by default, so you can test your [contribution](https://github.com/yiisoft/db-mssql/blob/master/.github/CONTRIBUTING.md) in the cloud. | ||
|
||
> Note: We recommend pull requesting in draft mode until all tests pass. | ||
## Docker image | ||
|
||
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. | ||
|
||
1. [MSSQL 2022](../../../docker-compose.yml) | ||
|
||
For running the docker containers you can use the following command: | ||
|
||
```shell | ||
docker compose up -d | ||
``` | ||
|
||
## Unit testing | ||
|
||
The package is tested with [PHPUnit](https://phpunit.de/). | ||
|
||
The following steps are required to run the tests: | ||
|
||
1. Run the docker container for the dbms. | ||
2. Install the dependencies of the project with composer. | ||
3. Run the tests. | ||
|
||
```shell | ||
vendor/bin/phpunit | ||
``` | ||
|
||
- More information can be found in the [Internals.](../../internals.md) |
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,35 @@ | ||
# Testing | ||
|
||
## Github actions | ||
|
||
All our packages have github actions by default, so you can test your [contribution](https://github.com/yiisoft/db-mssql/blob/master/.github/CONTRIBUTING.md) in the cloud. | ||
|
||
> Note: We recommend pull requesting in draft mode until all tests pass. | ||
## Docker image | ||
|
||
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. | ||
|
||
1. [MSSQL 2022](../../../docker-compose.yml) | ||
|
||
For running the docker containers you can use the following command: | ||
|
||
```shell | ||
docker compose up -d | ||
``` | ||
|
||
## Unit testing | ||
|
||
The package is tested with [PHPUnit](https://phpunit.de/). | ||
|
||
The following steps are required to run the tests: | ||
|
||
1. Run the docker container for the dbms. | ||
2. Install the dependencies of the project with composer. | ||
3. Run the tests. | ||
|
||
```shell | ||
vendor/bin/phpunit | ||
``` | ||
|
||
- More information can be found in the [Internals.](../../internals.md) |
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