Skip to content

Commit 6df4cf0

Browse files
feat: rename repo surface and add source-aware Databricks targets (#21)
* feat: rename repo surface and add source-aware Databricks targets * fix: keep delta smoke schemas isolated from source defaults
1 parent 4306f62 commit 6df4cf0

30 files changed

Lines changed: 353 additions & 88 deletions

.depot/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ jobs:
1414
contents: write
1515
pull-requests: write
1616
outputs:
17-
release_created: ${{ steps.release.outputs['apps/convex-sync--release_created'] }}
18-
tag_name: ${{ steps.release.outputs['apps/convex-sync--tag_name'] }}
17+
release_created: ${{ steps.release.outputs.release_created }}
18+
tag_name: ${{ steps.release.outputs.tag_name }}
1919
paths_released: ${{ steps.release.outputs.paths_released }}
2020
steps:
2121
- name: run-release-please

.release-please-manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"apps/convex-sync": "0.0.2"
2+
".": "0.0.2"
33
}

CHANGELOG.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
11
# Changelog
22

3-
All notable changes to this project will be documented in this file.
3+
## [0.0.2](https://github.com/shpitdev/convex-sync-kit/compare/v0.0.1...v0.0.2) (2026-04-20)
44

5+
### Features
6+
7+
* automate stable releases from conventional PR titles ([#9](https://github.com/shpitdev/convex-sync-kit/issues/9)) ([494d7ea](https://github.com/shpitdev/convex-sync-kit/commit/494d7eab5ab33b4067e57d135ffdaa4e93bdb8cc))
8+
9+
### Bug Fixes
10+
11+
* make cargo package versions explicit for release-please ([#10](https://github.com/shpitdev/convex-sync-kit/issues/10)) ([00f3993](https://github.com/shpitdev/convex-sync-kit/commit/00f3993a2fb55728fe2c553d4c9b13dfd34192e9))
12+
* point release-please at convex-sync package ([#11](https://github.com/shpitdev/convex-sync-kit/issues/11)) ([04e5671](https://github.com/shpitdev/convex-sync-kit/commit/04e56710e464df453a29d2ad228177e290e365c6))
13+
14+
All notable changes to `convex-sync-kit` will be documented in this file.

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# convex-streaming-olap-export
1+
# convex-sync-kit
22

33
- `Language`: ![Rust](https://img.shields.io/badge/Rust-000000?logo=rust&logoColor=white)
44
- `Source`: ![Convex](https://img.shields.io/badge/Convex-EE342F?logo=convex&logoColor=white)
@@ -22,7 +22,7 @@ extraction model:
2222

2323
```mermaid
2424
flowchart TD
25-
Root[convex-streaming-olap-export]
25+
Root[convex-sync-kit]
2626
Inspect[apps/convex-inspect]
2727
CLI[apps/convex-sync]
2828
Core[crates/convex-sync-core]
@@ -49,13 +49,14 @@ Read the repo by layer:
4949
- [`platform/databricks/README.md`](platform/databricks/README.md): Databricks target family overview
5050
- [`platform/databricks/s3/README.md`](platform/databricks/s3/README.md): Databricks consuming the S3 export path
5151
- [`platform/databricks/delta/README.md`](platform/databricks/delta/README.md): Databricks Delta bronze/silver landing
52+
- [`sources/README.md`](sources/README.md): source-specific defaults layered on top of the shared engine
5253

5354
## Install
5455

5556
Release install:
5657

5758
```bash
58-
curl -fsSL https://raw.githubusercontent.com/shpitdev/convex-streaming-olap-export/main/install.sh | bash
59+
curl -fsSL https://raw.githubusercontent.com/shpitdev/convex-sync-kit/main/install.sh | bash
5960
```
6061

6162
Local checkout dev install:
@@ -73,6 +74,17 @@ Current release coverage:
7374
- command symlinks go in `~/.local/bin`
7475
- `convex-inspect` is repo-local today and not part of the release artifact
7576

77+
## Source Configs
78+
79+
The repo name stays generic. Source-specific defaults live under `sources/`.
80+
81+
- current source profile: `sources/meshix-api/env.sh`
82+
- activate a source by setting `CONVEX_SYNC_SOURCE=<slug>`
83+
- explicit env vars still win over source defaults
84+
85+
This is the intended scaling model for running the same engine against many
86+
Convex projects without forking the repo or renaming the binaries.
87+
7688
## Operator Binaries
7789

7890
- `convex-inspect`: inspect Convex schemas, snapshot pages, and delta pages directly
@@ -145,10 +157,18 @@ Runtime split:
145157
Packaged entrypoints:
146158

147159
- `just databricks-delta-sync-secret`
160+
- `just databricks-delta-bootstrap <warehouse_id>`
148161
- `just databricks-delta-deploy`
149162
- `just databricks-delta-run`
150163
- `just databricks-delta-smoke <warehouse_id>`
151164

165+
Recommended production naming:
166+
167+
- S3-backed Databricks schema: `convex_sync_kit_<source>_s3`
168+
- Delta control schema: `convex_sync_kit_<source>_delta_control`
169+
- Delta bronze schema: `convex_sync_kit_<source>_delta_bronze`
170+
- Delta silver schema: `convex_sync_kit_<source>_delta_silver`
171+
152172
### `Databricks over S3`
153173

154174
This variation keeps the existing Rust exporter and S3 publish loop, then adds:
@@ -199,7 +219,7 @@ Stable releases are driven by merged PR titles on `main`.
199219

200220
- use conventional PR titles such as `feat: ...`, `fix: ...`, or `deps: ...`
201221
- `release-please` now starts release history from commit `0cf9f47`
202-
- merge to `main` opens or advances the stable release PR automatically when a releasable PR lands
222+
- merge to `main` opens or advances the stable release PR automatically when a releasable PR lands anywhere the repo-wide release config considers in scope
203223
- both release workflows also support manual `workflow_dispatch`, so there is always a button path in GitHub Actions
204224

205225
## References

apps/convex-sync/CHANGELOG.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

install.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ set -euo pipefail
33

44
BINARY_NAME="convex-sync"
55
DEV_BINARY_NAME="${CONVEX_SYNC_DEV_BIN_NAME:-convex-sync-dev}"
6-
REPO="shpitdev/convex-streaming-olap-export"
6+
REPO="shpitdev/convex-sync-kit"
77

88
VERSION="${CONVEX_SYNC_VERSION:-latest}"
99
INSTALL_MODE="${CONVEX_SYNC_INSTALL_MODE:-auto}"

justfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,9 @@ databricks-apply-sql-dir profile warehouse_id sql_dir:
7878
databricks-delta-sync-secret *args:
7979
./scripts/ensure-databricks-delta-secret.sh {{args}}
8080

81+
databricks-delta-bootstrap warehouse_id profile="DEFAULT":
82+
./scripts/bootstrap-databricks-delta.sh {{profile}} {{warehouse_id}}
83+
8184
databricks-delta-deploy profile="DEFAULT" target="dev":
8285
./scripts/deploy-databricks-delta.sh {{profile}} {{target}}
8386

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
aws_region = "us-east-1"
22
aws_account_id = "123456789012"
3-
bucket_name = "example-convex-streaming-olap-export-bucket"
3+
bucket_name = "example-convex-sync-kit-bucket"
44
current_prefix = "prod/staging/current"
5-
role_name = "example-convex-streaming-olap-export-databricks-prod-reader"
5+
role_name = "example-convex-sync-kit-databricks-prod-reader"
66
databricks_unity_catalog_role_arn = "arn:aws:iam::123456789012:role/unity-catalog-prod-UCMasterRole-EXAMPLE"
77
external_id = ""
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
aws_region = "us-east-1"
2-
bucket_name = "example-convex-streaming-olap-export-bucket"
2+
bucket_name = "example-convex-sync-kit-bucket"
33
current_prefix = "prod/staging/current"
4-
role_name = "example-convex-streaming-olap-export-palantir-prod-reader"
4+
role_name = "example-convex-sync-kit-palantir-prod-reader"
55
palantir_cloud_identity_role_arn = "arn:aws:iam::123456789012:role/foundry-cloud-identity-example"

platform/aws/s3_consumers/terraform/palantir_oidc_reader_role/terraform.tfvars.example

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
aws_region = "us-east-1"
2-
bucket_name = "example-convex-streaming-olap-export-bucket"
2+
bucket_name = "example-convex-sync-kit-bucket"
33
current_prefix = "prod/staging/current"
4-
role_name = "example-convex-streaming-olap-export-palantir-oidc-prod-reader"
4+
role_name = "example-convex-sync-kit-palantir-oidc-prod-reader"
55
oidc_provider_arn = "arn:aws:iam::123456789012:oidc-provider/example"
66
oidc_issuer_url = "https://example.oidc.palantir.com/foundry"
77
oidc_audience = "replace-me"

0 commit comments

Comments
 (0)