Skip to content

Commit 17aab32

Browse files
authored
Merge pull request #6 from postgres-ai/texts-and-look-improvements
Improve texts
2 parents b7438d1 + eb6650e commit 17aab32

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
1-
# DB Migrations checking action
1+
# Database Lab (Postgres.ai) to test DB migrations in CI
22

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)
44

55
## 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.
77

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 outside the secure container
12+
- Collect useful artifacts (such as `pg_stat_***` system views) and use them to empower your DB changes review process
1213

1314
## 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.
1516

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.
1718

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)
2122

23+
YAML file example:
2224
```yaml
2325
on: [ push ]
2426

@@ -60,5 +62,4 @@ jobs:
6062
# Show migration summary
6163
- name: Get the response status
6264
run: echo "${{ steps.db-migrations.outputs.response }}"
63-
6465
```

0 commit comments

Comments
 (0)