Repository navigation
docs: refresh READMEs and scope CI triggers by language - #1111
Merged
ColinLeeo merged 3 commits intoNov 16, 2026
Merged
Conversation
Fix outdated Java API snippets (TSRecord, DataPoint, Path, writeRecord), the released dependency version, and the example class list. Align the C++ parallel-write API names and Chinese build instructions, and point the Python README at the real example and API modules. Update the CLI command table and encoding matrix to match current behavior and the current IoTDB reference documentation.
Replace broad paths-ignore filters with per-language path whitelists so documentation-only changes and unrelated language directories do not start builds. Keep shared build inputs (pom.xml, mvnw, .mvn, checkstyle.xml, and the compatibility matrix) in the workflows that consume them, and document the maintenance rule in CLAUDE.md. Build the native library without C++ test targets in the Go and CodeQL workflows, which do not run C++ unit tests.
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The CodeQL path allowlists omit packaging/** for pushes and pull requests, causing packaging-only Python changes to skip per-change security analysis.
1 open issue
What changed in this PR
This PR refreshes TsFile’s documentation to match current APIs and CLI behavior, and narrows CI triggers to reduce builds for documentation-only and unrelated-language changes.
Changes:
- Correct English and Chinese SDK instructions, Java examples, and CLI documentation.
- Scope workflow path filters by language and shared build inputs.
- Disable native test builds for Go-related jobs and document path-filter maintenance.
| File | Description |
|---|---|
README.md |
Refresh encoding recommendations and CLI reference. |
README-zh.md |
Align Chinese encoding and CLI documentation. |
python/README.md |
Correct public API and example paths. |
python/README-zh.md |
Correct Chinese API and example references. |
java/tsfile/README.md |
Update dependency version and API snippets. |
java/tsfile/README-zh.md |
Fix Chinese dependency and API examples. |
java/examples/readme.md |
Describe current writer and reader examples. |
cpp/README.md |
Correct threading API namespaces. |
cpp/README-zh.md |
Update build instructions and threading guidance. |
CLAUDE.md |
Document CI path-filter maintenance. |
.github/workflows/unit-test-python.yml |
Scope triggers to Python, C++, and build inputs. |
.github/workflows/unit-test-python-msvc.yml |
Apply scoped triggers to Windows Python tests. |
.github/workflows/unit-test-java.yml |
Scope triggers to Java and shared inputs. |
.github/workflows/unit-test-go.yml |
Exclude Markdown and disable native test builds. |
.github/workflows/unit-test-cpp.yml |
Scope triggers to C++ and shared inputs. |
.github/workflows/unit-test-cpp-msvc.yml |
Apply scoped triggers to Windows C++ tests. |
.github/workflows/cppcheck.yml |
Narrow triggers to relevant native analysis inputs. |
.github/workflows/cpp-dependency-source.yml |
Exclude Markdown and C++ documentation. |
.github/workflows/compatibility-test.yml |
Exclude Markdown from compatibility triggers. |
.github/workflows/codeql.yml |
Add path filters and streamline Go’s native build. |
.github/workflows/code-coverage.yml |
Scope coverage triggers to Java, C++, and shared inputs. |
Review effort: Balanced
Packaging scripts and tests are Python sources analyzed by CodeQL. Add packaging/** to the push and pull-request allowlists while retaining the Markdown exclusion.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

What changed
Documentation
2.5.0, fixTSRecordargument order, theDataPoint.getDataPointvalue type, thePathconstructor,writeRecord, and the reader variable; rewritejava/examples/readme.mdaround the actual example classes.common::namespace for the parallel-write switches, replace the removedset_write_thread_countwithset_thread_count, correct the default pool description, and fix the Chinese build instructions and output paths.examples/example.pyand the real public API modules.tsfile-clicommand table and output formats with the implementation, and align the encoding table and reference links (TEXT -> PLAIN, add DATE/TIMESTAMP/STRING/BLOB) with the current IoTDB documentation.CI
paths-ignorefilters with per-languagepathswhitelists, excluding Markdown and unrelated language directories.pom.xml,mvnw,mvnw.cmd,.mvn/**,checkstyle.xml, andcompat/compatibility-matrix.csv) in the workflows that consume them.-Dbuild.test=OFFin the Go and CodeQL workflows, which do not run C++ unit tests.CLAUDE.md.Why
Documentation-only changes and changes to another language currently start C++/Java/Python test matrices. With these filters, a README-only PR matches no test workflow.
Validation
git diff --checkcompat/compatibility-matrix.csvtriggers the Java/C++ suites, coverage, and the compatibility matrixReviewer notes
-P with-pythonincludes thecppmodule andverifyreaches the CTest phase.