Skip to content

fix readme #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
guyb1 merged 1 commit into from
Aug 13, 2025
+8 −12
Merged

fix readme #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,8 @@ jobs:
chartdb-api-token: ${{ secrets.TEST_CHARTDB_API_TOKEN || 'test_token' }}
chartdb-diagram-id: ${{ secrets.TEST_CHARTDB_DIAGRAM_ID || 'test_diagram' }}

- name: Check for errors in output
- name: Check sync status
if: steps.chartdb-sync-postgres.outputs.status == 'failed'
run: |
echo "Checking action output for errors..."
if echo "${{ steps.chartdb-sync-postgres.outputs.* }}" | grep -i "error"; then
echo "Error found in action output!"
exit 1
else
echo "No errors found in output"
fi
echo "ChartDB sync failed! Check the logs above."
exit 1
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Automatically sync your database schema with [ChartDB](https://chartdb.io) to ke
- 📊 Updates ChartDB diagrams in real-time
- 🔒 Secure handling of credentials via GitHub Secrets
- 🐳 Docker-based for consistent execution
- 🗄️ Supports PostgreSQL, MySQL, MariaDB, and MSSQL

- 🗄️ Supports PostgreSQL, MySQL, SQL Server, MariaDB, SQLite, ClickHouse, CockroachDB, and Oracle
x
## Usage

### Basic Example
Expand Down Expand Up @@ -97,7 +97,7 @@ jobs:
| `db-database` | Database name | Yes | - |
| `db-username` | Database username | Yes | - |
| `db-password` | Database password (use secrets!) | No | - |
| `db-type` | Database type (`postgresql`, `mysql`, `mariadb`, `mssql`) | Yes | - |
| `db-type` | Database type (`postgresql`, `mysql`, `sql_server`, `sqlite`, `mariadb`, `clickhouse`, `cockroachdb`, `oracle`) | Yes | - |
| `chartdb-api-token` | ChartDB API token (use secrets!) | Yes | - |
| `chartdb-diagram-id` | ChartDB diagram ID to sync with | Yes | - |
| `network` | Docker network mode | No | `host` |
Expand Down Expand Up @@ -165,7 +165,7 @@ db-port: '3306' # default

### Microsoft SQL Server
```yaml
db-type: 'mssql'
db-type: 'sql_server'
db-port: '1433' # default
```

Expand Down