mirror of
https://github.com/lancedb/lancedb.git
synced 2026-11-13 22:26:53 +00:00
Add a central documentation link registry (`lancedb::docs::DocLink`) in the Rust core that builds `docs.lancedb.com` URLs with UTM parameters (`utm_source=lancedb_sdk`, `utm_medium=warning|error`, `utm_campaign=<id>`, `utm_content=<sdk>-<version>`) placed before any `#anchor` fragment and without user-identifying data. - Initialize `utm_content` per language binding (`python`, `nodejs`, `cli`, defaulting to `rust`) and expose the link builder to Python so `DBConnection` and `Job` stubs reuse the core definitions. - Append published documentation links to Enterprise-only `NotSupported` / `NotImplementedError` errors across database, job, catalog, and table operations. - Emit rate-limited maintenance warnings (once per table per process when `warn` logging is enabled) when opening a native table with at least 100 small fragments (`< 100k` physical rows each) or at least 1,000,000 unindexed rows on an optimizable user index, reading only manifest metadata without opening data or `_indices/` files, and document the thresholds in the compaction and reindexing guides. - Verify published/in-repo `docs/web/` targets and `#anchor` fragments in unit tests and include extracted SDK links in the scheduled `docs-link-check` workflow. Linear: OSS-2772
51 lines
1.2 KiB
YAML
51 lines
1.2 KiB
YAML
name: CI scripts
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- Cargo.toml
|
|
- python/pyproject.toml
|
|
- ci/check_cargo_lock.py
|
|
- ci/check_sdist.py
|
|
- ci/extract_sdk_doc_links.py
|
|
- ci/build_cli_linux.sh
|
|
- ci/package_cli.py
|
|
- .bumpversion.toml
|
|
- rust/lancedb/cli/Cargo.toml
|
|
- ci/set_lance_version.py
|
|
- ci/tests/**
|
|
- .github/workflows/ci-scripts.yml
|
|
pull_request:
|
|
paths:
|
|
- Cargo.toml
|
|
- python/pyproject.toml
|
|
- ci/check_cargo_lock.py
|
|
- ci/check_sdist.py
|
|
- ci/extract_sdk_doc_links.py
|
|
- ci/build_cli_linux.sh
|
|
- ci/package_cli.py
|
|
- .bumpversion.toml
|
|
- rust/lancedb/cli/Cargo.toml
|
|
- ci/set_lance_version.py
|
|
- ci/tests/**
|
|
- .github/workflows/ci-scripts.yml
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
test:
|
|
name: Test CI scripts
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v6
|
|
- uses: actions/setup-python@v6
|
|
with:
|
|
python-version: "3.13"
|
|
- name: Install test dependencies
|
|
run: python -m pip install packaging
|
|
- name: Run tests
|
|
run: python -m unittest discover -s ci/tests -v
|