Skip to content

docs: shorten the README, add a release workflow, and allow Langfuse patch releases - #37

Merged
notdodo merged 2 commits into
mainfrom
docs/public-readiness
Nov 15, 2026
Merged

notdodo merged 2 commits into
mainfrom
docs/public-readiness

Conversation

@notdodo

@notdodo notdodo commented Nov 15, 2026 •

Copy link
Copy Markdown
Member

Summary

  • README: rewritten at about 100 lines, down from 336. It covers install, a short usage example, a one-line overview per module, redaction, limitations, development, versioning and license, in plain prose with no exhaustive parameter lists. For the configuration fields it points to LangfuseClientConfig in client.py.
  • Release workflow: .github/workflows/release.yml runs on v* tags. It checks the tag against the package version, runs task check and task test, builds and attests the wheel and sdist, and publishes the GitHub release with that version's CHANGELOG section as notes.
  • Langfuse range: relaxed from ==5.2.0 to >=5.2.0,<5.3. tests/package_contract/test_langfuse_internals.py checks the private SDK internals the package relies on, so a breaking Dependabot bump fails CI.
  • CHANGELOG: an [Unreleased] section. Changing the Langfuse range counts as a minor version, so the next release is 0.5.0.

Validation

  • task format check test: 154 passed, 4 e2e deselected, 90% coverage, no warnings.
  • actionlint and zizmor are clean on both workflows.
  • README snippets: every import is in its module's __all__, and every keyword argument matches the real signature.
  • The release workflow can only really be tested by the next tag push.

🤖 Generated with Claude Code

…tch range

- README: configuration table, per-module reference, limitations, and
  pointers to runnable examples under examples/, which the test suite
  compiles and runs offline. Taskfile lint and type checks cover them.
- Release workflow: on v* tags, check the tag against the package
  version, run the checks, build and attest the wheel and sdist, and
  publish the GitHub release with notes from CHANGELOG.md.
- Relax langfuse from ==5.2.0 to >=5.2.0,<5.3, and guard the private SDK
  internals the package relies on with focused contract tests.
@github-actions

Copy link
Copy Markdown

kics-logo

KICS version: v2.2.1

Category Results
CRITICAL CRITICAL 0
HIGH HIGH 0
MEDIUM MEDIUM 0
LOW LOW 0
INFO INFO 0
TRACE TRACE 0
TOTAL TOTAL 0
Metric Values
Files scanned placeholder 3
Files parsed placeholder 3
Files failed to scan placeholder 0
Total executed queries placeholder 4
Queries failed to execute placeholder 0
Execution time placeholder 0

Queries Results

|
|

@notdodo notdodo changed the title docs: add reference docs, examples, release workflow, and Langfuse patch range docs: shorten the README, add a release workflow, and allow Langfuse patch releases Nov 15, 2026
@notdodo
notdodo merged commit d93c3c7 into main Nov 15, 2026
4 of 5 checks passed
notdodo added a commit that referenced this pull request Nov 15, 2026
## Problem
Python 3.15 CI takes about 14 minutes whenever `uv.lock` changes, which
includes every Dependabot PR and #37:

- The venv cache key and setup-uv's own cache key both include the
lockfile hash, and neither has a fallback. A changed lockfile misses
both.
- There are no 3.15 wheels yet for numpy, pydantic-core, thinc and
others, so a miss means compiling all of them from source.
- setup-uv's Python cache misses too. A restored venv whose interpreter
is missing gets deleted and rebuilt, which is the same failure #36 fixed
for exact hits.

## Fix
- `restore-keys: python-<ver>-venv-` on the venv cache. A lockfile
change now restores the latest venv for that Python version, `task
install` applies only the changed packages, and the result is saved
under the new key.
- `uv python install <ver>` runs before `task install`, so the restored
venv always has its interpreter.

## Validation
- actionlint and zizmor are clean.
- This PR doesn't change `uv.lock`, so its run is an exact cache hit.
The fallback path gets its real test when #37, which does change the
lockfile, is updated from `main` after this merges. Its 3.15 job should
drop from about 14 minutes to roughly 1.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@notdodo
notdodo deleted the docs/public-readiness branch November 15, 2026 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant