Skip to content

Commit 43b4856

Browse files
authored
Update README.md
1 parent 48927ef commit 43b4856

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
11
# Automated testing of DB changes in CI/CD pipelines using thin clones provided by Database Lab (Postgres.ai)
22

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

55
## Overview
6-
**Database Lab DB migration checker** is a tool to automatically test migrations in CI/CD pipelines.
6+
This GitHub action tests database schema changes (DB migrations) automatically using thin clones of large databases provided by Database Lab Engine (DLE).
7+
8+
[**Database Lab Engine**](https://postgres.ai/docs/database-lab) is an open-source technology which is a core component of the Database Lab Platform. It is used to build powerful, state-of-the-art development and testing environments, based on a simple idea: with modern thin cloning technologies, it becomes possible to iterate 100x faster in development and testing. It is extremely helpful for larger or small but very agile teams that want to achieve high development velocity and the most competitive "time to market" characteristics, and save budgets on non-production infrastructure.
9+
10+
[**Database Lab DB Migration Checker**](https://postgres.ai/docs/db-migration-checker) is a DLE's component that enables integration with CI/CD tools to automatically test migrations in CI/CD pipelines.
711

812
## 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
13+
- **Automated:** DB migrations testing in CI/CD pipelines
14+
- **Realistic:** test results are realistic because real or close-to-real (the same size but no personal data) databases are used, thin-cloned in seconds and destroyed after testing is done
15+
- **Fast and inexpensive:** a single machine with single disk can operate dozens of independent thin clones
16+
- **Well-tested DB changes to avoid deployment failures:** DB Migration Checker automatically detects (and prevents!) long-lasting dangerous locks that could put your production systems down
17+
- **Secure**: DB Migration Checker runs all tests in a secure environment: data cannot be copied outside the secure container
18+
- **Lots of useful data points**: Collect useful artifacts (such as `pg_stat_***` system views) and use them to empower your DB changes review process
1319

1420
## How to use
1521
To use the action, create a YAML file in the `.github/workflows/` directory.

0 commit comments

Comments
 (0)