From 804c2cfa3ca36dc22aa9c1a81ec9fe53c4037622 Mon Sep 17 00:00:00 2001 From: csoceanu Date: Wed, 26 Aug 2026 13:47:24 +0300 Subject: [PATCH] docs: fix version references to v1 and prep v1.1.2 release The README pointed users to a non-existent @v0 tag. Actual release tags are v1.x (latest v1.1.1), so point users to @v1 (recommended moving tag) and @v1.1.2 as the exact-pin example. Also add the [1.1.2] CHANGELOG section for the fixes landed since v1.1.1 and bump pyproject version, which had drifted at 0.1.0 across all v1.x releases. Co-Authored-By: Claude Opus 4.8 (1M context) --- CHANGELOG.md | 11 +++++++++++ README.md | 6 +++--- pyproject.toml | 2 +- 3 files changed, 15 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d7d3815..040ad6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [1.1.2] - 2026-08-26 + +### Fixed + +- Normalize `DOCS_SUBFOLDER` trailing slash and resolve paths with + `os.path.normpath` before comparing against the current working directory +- Clean up stale semantic indexes when their documentation files are deleted, + fetching the base branch ref for accurate change detection +- Build git `ls-tree` / `cat-file` / `show` pathspecs relative to the current + working directory using `git rev-parse --show-prefix` + ## [0.1.0] - 2026-08-16 Initial tagged release. The action has been in use since September 2025; diff --git a/README.md b/README.md index cb6969d..7b4d04f 100644 --- a/README.md +++ b/README.md @@ -150,7 +150,7 @@ jobs: "AUTHORIZATION: basic $(echo -n "x-access-token:${GH_TOKEN}" | base64 -w 0)" - name: Documentation Assistant - uses: redhat-community-ai-tools/code-to-docs@v0 + uses: redhat-community-ai-tools/code-to-docs@v1 with: model-api-base: ${{ secrets.MODEL_API_BASE }} model-api-key: ${{ secrets.MODEL_API_KEY }} @@ -200,8 +200,8 @@ These are set as `with:` parameters in the workflow step (not as secrets): ### Versioning -- `@v0` receives all backward-compatible updates (recommended) -- `@v0.1.0` pins to an exact release +- `@v1` receives all backward-compatible updates (recommended) +- `@v1.1.2` pins to an exact release - `@main` tracks unreleased changes and is not stable ### Supported Model Backends diff --git a/pyproject.toml b/pyproject.toml index 9ae989d..38a7eb2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "code-to-docs" -version = "0.1.0" +version = "1.1.2" description = "GitHub Action that generates documentation suggestions from code changes using LLMs" requires-python = ">=3.12" license = {text = "MIT"}