https://github.com/synthesized-io/tdk-gha
GitHub Actions for free version of Synthesized TDK
https://github.com/synthesized-io/tdk-gha
Last synced: 5 days ago
JSON representation
GitHub Actions for free version of Synthesized TDK
- Host: GitHub
- URL: https://github.com/synthesized-io/tdk-gha
- Owner: synthesized-io
- Created: 2022-11-17T14:53:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T18:24:32.000Z (7 months ago)
- Last Synced: 2025-06-13T05:44:03.251Z (16 days ago)
- Homepage: https://synthesized.io
- Size: 6.84 KB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Run Synthesized TDK Action
Runs free version of [Synthesized TDK](https://docs.synthesized.io/tdk/latest/) as part of GitHub Actions workflows.
## Usage
See [action.yml](action.yml). Notes:
- The runner, either GitHub-hosted or self-hosted, must have access to both input and output databases.
- For transient databases with their life span limited to a single workflow run, it is convenient to
use [service containers](https://docs.github.com/en/actions/using-containerized-services/about-service-containers).
For examples of how this can be done, refer to [a test workflow provided in this repository](.github/workflows/run-tdk-test.yml).
> :point_up: Note that in your workflows you will need to replace the job setting `uses: ./` with `uses: synthesized-io/tdk-gha@`
- For an exhaustive description of configuration syntax and available settings, please refer to the [official TDK documentation](https://docs.synthesized.io/tdk/latest/).
- You can find out which features are available in the free version of TDK and which are not from the
[comparison table](https://docs.synthesized.io/tdk/latest/#_free_vs_paid_versions).
### Masking a database
```yaml
uses: synthesized-io/tdk-gha@v1
with:
input_url: jdbc:yourdb://input-db-host:1234
input_username: dbuser
input_password: ${{ secrets.input_db_password }}
output_url: jdbc:yourdb://output-db-host:8765
output_username: dbuser
output_password: ${{ secrets.output_db_password }}
user_config: |
default_config:
mode: MASKING
schema_creation_mode: DROP_AND_CREATE
```
### Generating a database
```yaml
uses: synthesized-io/tdk-gha@v1
with:
input_url: jdbc:yourdb://input-db-host:1234
input_username: dbuser
input_password: ${{ secrets.input_db_password }}
output_url: jdbc:yourdb://output-db-host:8765
output_username: dbuser
output_password: ${{ secrets.output_db_password }}
user_config: |
default_config:
mode: GENERATION
schema_creation_mode: DROP_AND_CREATE
```