|
1 | | -# DB Migrations checking action |
| 1 | +# Database Lab (Postgres.ai) to test DB migrations in CI |
2 | 2 |
|
3 | | -A GitHub action to run DB migrations with Database Lab Engine (DLE) |
| 3 | +This GitHub action tests DB migrations database schema changes (database migrations) automatically using thin clones of large databases provided by Database Lab Engine (DLE) |
4 | 4 |
|
5 | 5 | ## Overview |
6 | | -**Database Lab DB migration checker** is a tool to automatically validate migrations in the CI pipeline. |
| 6 | +**Database Lab DB migration checker** is a tool to automatically test migrations in CI/CD pipelines. |
7 | 7 |
|
8 | | -## Database Lab DB migration checker's benefits: |
9 | | -- Check migrations as a part of a standard pipeline |
10 | | -- Protect DLE from data stealing - run migrations in a protected environment |
11 | | -- Protect logs and artifacts from being revealed |
| 8 | +## Key features |
| 9 | +- Check migrations as a part of a standard CI/CD pipeline |
| 10 | +- Automatically detect (and prevent!) long-lasting dangerous locks that could put your production systems down |
| 11 | +- Run all tests in secure environment: data cannot be copied to outside of a secured container |
| 12 | +- Collect useful artifacts (such as `pg_stat_***` system views) and use them to enpower your DB changes review process |
12 | 13 |
|
13 | 14 | ## How to use |
14 | | -To use the action, create a yml file in the `.github/workflows/` directory. |
| 15 | +To use the action, create a YAML file in the `.github/workflows/` directory. |
15 | 16 |
|
16 | | -Copy and paste the installation snippet from the [Marketplace page](https://github.com/marketplace/actions/database-lab-migration-checker) into your .yml file. |
| 17 | +Copy and paste the installation snippet from the [Marketplace page](https://github.com/marketplace/actions/database-lab-migration-checker) into your `.yml` file. |
17 | 18 |
|
18 | | -Check out the [Database Lab DB migrations checker documentation](https://postgres.ai/docs/db-migration-checker) to learn how it works and see available configuration options |
19 | | - |
20 | | -For example, |
| 19 | +Check out the docs to learn more: |
| 20 | +-[DB Migration Checker. How to test DB changes in CI/CD automatically](https://postgres.ai/docs/db-migration-checker) |
| 21 | +-[DB Migration Checker configuration reference](https://postgres.ai/docs/reference-guides/db-migration-checker-configuration-reference) |
21 | 22 |
|
| 23 | +YAML file example: |
22 | 24 | ```yaml |
23 | 25 | on: [ push ] |
24 | 26 |
|
|
60 | 62 | # Show migration summary |
61 | 63 | - name: Get the response status |
62 | 64 | run: echo "${{ steps.db-migrations.outputs.response }}" |
63 | | - |
64 | 65 | ``` |
0 commit comments