Skip to content

Commit 3e6ca52

Browse files
committed
Update CHANGELOG.md in preparation for next patch release.
Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
1 parent 39393e6 commit 3e6ca52

3 files changed

Lines changed: 26 additions & 2 deletions

File tree

.github/workflows/release.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,14 @@ jobs:
6666
- name: Build Package
6767
run: poetry build
6868

69+
- name: Read Changelog Entry
70+
id: changelog_reader
71+
uses: mindsers/changelog-reader-action@v2
72+
with:
73+
validation_level: warn
74+
version: ${{ steps.tag_name.outputs.current_version }}
75+
path: ./CHANGELOG.md
76+
6977
- name: Build Changelog
7078
id: gen_changelog
7179
uses: mikepenz/release-changelog-builder-action@v5

CHANGELOG.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,26 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [v1.1.0] - 2025-08-21
8+
## [v1.0.7] - 2025-08-21
9+
10+
### Added
11+
- Doctest-style Examples across the public API surface of JavaAnalysis, PythonAnalysis, CAnalysis, and core CLDK helpers. Coverage includes Java CRUD operations and comment/docstring query APIs, plus concise inline examples for Python and C where applicable.
12+
- Examples documenting expected NotImplementedError behavior for placeholder APIs (PythonAnalysis and CAnalysis) using doctest flags.
13+
14+
### Changed
15+
- Converted and standardized docstrings to strict Google style (Args, Returns, Raises, Examples) across edited modules.
16+
- Standardized Examples to use the CLDK facade (e.g., `CLDK(language="java").analysis(...)`) instead of raw constructor calls.
17+
- Normalized all doctest Example inputs to single-line strings to ensure reliable mkdocstrings rendering.
18+
- Clarified `CLDK.analysis` return type with a precise union: `JavaAnalysis | PythonAnalysis | CAnalysis`.
919

1020
### Fixed
1121
- Fixed README.md logo display on PyPI by updating image URLs to use raw GitHub URLs and maintaining theme-based auto-switching with proper fallback
22+
- mkdocstrings rendering issues caused by multi-line doctest strings and formatting inconsistencies.
23+
- Replaced confusing examples like `JavaAnalysis(None, None, ...)` with clear CLDK-based initialization patterns.
24+
- Packaging: ensured the built wheel includes the `cldk` package by adding `packages = [{ include = "cldk" }]` to Poetry configuration.
25+
26+
### Removed
27+
- Multi-line doctest strings in Examples that broke mkdocstrings rendering; all examples are now single-line.
1228

1329
## [v1.0.6] - 2025-07-23
1430

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "cldk"
3-
version = "1.0.6"
3+
version = "1.0.7"
44
description = "The official Python SDK for Codellm-Devkit."
55
authors = ["Rahul Krishna <i.m.ralk@gmail.com>", "Rangeet Pan <rangeet.pan@ibm.com>", "Saurabh Sinhas <sinhas@us.ibm.com>",
66
"Raju Pavuluri <pavuluri@us.ibm.com>"]

0 commit comments

Comments
 (0)