Skip to content

docs: fix version references to v1 and prep v1.1.2 release #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
csoceanu merged 1 commit into from
Aug 26, 2026
Merged

docs: fix version references to v1 and prep v1.1.2 release #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

@fullsend-ai-review fullsend-ai-review Bot Aug 26, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] documentation-consistency

The changelog jumps from [0.1.0] to [1.1.2] without entries for intermediate releases v1.0.0-v1.1.1. The PR body explains that pyproject.toml had drifted at 0.1.0 across every v1.x release. This gap predates the PR and the PR improves the situation by establishing proper changelog practice starting with v1.1.2. Consider backfilling entries for prior v1.x releases in a follow-up.


### 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;
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"}
Expand Down
Loading