Skip to content

docs: keep Latest News to product features, never CI/devx/bugs - #1162

Merged
vitali87 merged 2 commits into
mainfrom
docs/news-features-only
Aug 10, 2026
Merged

docs: keep Latest News to product features, never CI/devx/bugs#1162
vitali87 merged 2 commits into
mainfrom
docs/news-features-only

Conversation

@vitali87

@vitali87 vitali87 commented Aug 10, 2026

Copy link
Copy Markdown
Owner

The "Latest News" section had picked up a Release Automation entry — a tooling/devx item, not a user-facing feature. Latest News should be substantial product features and capabilities only. This removes that entry and prevents the kind from recurring, from every source.

Changes

  1. Remove the Release Automation bullet from NEWS.md; regenerate the README (now shows Ruby Support / Structural Search & Replace / Data-Flow Tracing).
  2. Editorial policy in the NEWS.md header — entries are headline features (language support, analysis, querying, graph, integrations); explicitly not CI, developer tooling, release/build automation, refactors, docs, tests, or bug fixes. This governs hand edits too.
  3. Deterministic guard in scripts/update_news.py — a new is_feature_theme() drops any bullet whose theme names non-feature work (automation, release, ci, devx, tooling, refactor, chore, workflow, bump, bug fix, …) before it can reach the README. This is a hard backstop independent of what the AI generator emits. Word-boundary matched so genuine features survive (e.g. Dependency Graph is kept, Dependency Bumps is dropped).
  4. Stronger AI prompt in version-bump.yml — "Cover ONLY substantial new user-facing product features … You MUST NOT include CI, developer experience, tooling, build or release automation, refactors, performance work, documentation, tests, dependency bumps, or bug fixes. When in doubt, omit."

Tests

  • test_drops_non_feature_themed_bullets — a fragment mixing Release Automation / CI / Bug Fixes / a real feature yields only the feature.
  • TestIsFeatureTheme — rejects the non-feature themes, accepts real product-feature themes (incl. the Dependency Graph vs Dependency Bumps boundary).
  • Full test_update_news.py: 13 passed. Lint + type-check clean; YAML valid.

Summary by CodeRabbit

  • New Features
    • Added a Latest News announcement for data-flow tracing, including FLOWS_TO taint edges across assignments, calls, and I/O sinks in C#, Java, C, and Go.
  • Documentation
    • Updated release-news guidance to prioritize substantial, user-facing product features.
    • Removed the Release Automation announcement from the Latest News section.
  • Bug Fixes
    • Improved news filtering so operational, maintenance, testing, and bug-fix topics are excluded from feature announcements.

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown

Review Change Stack

Important

Review skipped

No new commits to review since the last review.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: b491c075-6a1a-46e0-a397-7df5c291c0be

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

The news update flow filters non-feature themes, tests the filter, narrows generation guidance to user-facing features, and replaces the release automation news entry with a data-flow tracing entry.

Changes

Feature-only news filtering

Layer / File(s) Summary
Feature theme filtering and validation
scripts/update_news.py, codebase_rag/tests/test_update_news.py
The script rejects CI, tooling, release, refactoring, maintenance, documentation, testing, performance, and bug-fix themes. Tests cover rejected themes, accepted feature themes, and filtered bullets.

Feature-only generation guidance and published content

Layer / File(s) Summary
News guidance and published entries
.github/workflows/version-bump.yml, NEWS.md, README.md
Generation guidance and NEWS.md now target substantial user-facing features. README.md replaces the Release Automation entry with Data-Flow Tracing coverage.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the primary change: restricting Latest News to user-facing product features.
Description check ✅ Passed The description clearly explains the changes, rationale, filtering behavior, and test results, although it omits several template headings and checklist items.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/news-features-only

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@scripts/update_news.py`:
- Around line 28-42: Extend NON_FEATURE_THEME and the deterministic
is_feature_theme filtering to recognize Documentation, Tests, Refactors,
Bug-Fix, and Performance, including their relevant plural or punctuation
variants. Add regression cases in test_update_news.py covering each excluded
theme and verify extract_bullets does not pass them through as feature entries.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 6e9094d0-5511-4b90-91bf-363ebd4f6de9

📥 Commits

Reviewing files that changed from the base of the PR and between cd2d4d9 and 3ae99f4.

📒 Files selected for processing (5)
  • .github/workflows/version-bump.yml
  • NEWS.md
  • README.md
  • codebase_rag/tests/test_update_news.py
  • scripts/update_news.py

Comment thread scripts/update_news.py
@greptile-apps

greptile-apps Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This update broadens the Latest News theme filter for maintenance-oriented topics while preserving valid user-facing feature entries. The earlier report that valid feature themes were discarded is disproved: direct execution accepted and prepended both requested feature entries, while rejecting the CI control entry.

Confidence Score: 5/5

No blocking failure remains.

No accepted blocking findings remain. Direct execution confirmed that valid feature themes are retained and inserted into Latest News as intended.

T-Rex T-Rex Logs

What T-Rex did

  • Ran an independently authored Python check against extract_bullets() and prepend_news() using in-memory NEWS content; the control run exited 0 and confirmed CI Automation was excluded without changing NEWS.
  • The acceptance run of the same check exited 0 and showed both requested feature bullets in EXTRACTED and INSERTED, prepended ahead of the existing NEWS entry.
  • Before control run exited 0 and confirmed CI Automation exclusion with NEWS_UNCHANGED: True; after acceptance run exited 0 and printed both bullets in EXTRACTED and INSERTED, followed by NEWS with both prepended.
  • Uploaded the authored test source and captured the two command outputs for review.

View all artifacts

T-Rex Ran code and verified through T-Rex

Reviews (2): Last reviewed commit: "fix: broaden non-feature theme filter an..." | Re-trigger Greptile

Comment thread scripts/update_news.py
Comment thread scripts/update_news.py Outdated
@vitali87

Copy link
Copy Markdown
Owner Author

@coderabbitai @greptileai addressed in e5811d5 — broadened the non-feature filter (docs/tests/perf, plural/hyphen spellings), dropped the over-broad workflow/pipeline/toolchain keywords, and kept the guard theme-scoped by design (body content is governed by the generator prompt + editorial policy). Please re-review.

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown
🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

git show --stat --oneline e5811d55
git show --format=fuller --find-renames --find-copies -- \
  e5811d55 -- scripts/update_news.py codebase_rag/tests/test_update_news.py NEWS.md .github/workflows/version-bump.yml

ast-grep outline scripts/update_news.py --items all
ast-grep outline codebase_rag/tests/test_update_news.py --items all

Length of output: 4342


🏁 Script executed:

#!/bin/bash
set -euo pipefail

sed -n '18,95p' scripts/update_news.py
sed -n '1,105p' codebase_rag/tests/test_update_news.py

rg -n -C 3 '\b(?:is_feature_theme|extract_bullets)\s*\(' \
  scripts/update_news.py codebase_rag/tests/test_update_news.py

Length of output: 11027


@vitali87 Re-review complete. I found no new issues in the updated filter.

The filter now rejects the stated non-feature variants. It also allows feature themes such as Pipeline Analysis and Workflow Visualisation. The filter remains limited to the bullet theme, as intended.

I inspected the implementation and focused test assertions. I did not execute tests in the sandbox.


✏️ Learnings added
Learnt from: vitali87
URL: https://github.com/vitali87/code-graph-rag/pull/1162

Timestamp: 2026-08-10T13:41:43.452Z
Learning: In `scripts/update_news.py`, `NON_FEATURE_THEME` must evaluate only the parsed NEWS.md bullet theme. The bullet body is governed by the news-generation prompt and the editorial policy. Do not add broad `workflow`, `pipeline`, or `toolchain` keywords because valid user-facing feature themes can contain these terms.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

⚠️ Action not completed

Already reviewed.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@sonarqubecloud

Copy link
Copy Markdown

@vitali87
vitali87 merged commit beaaf51 into main Aug 10, 2026
26 checks passed
@vitali87
vitali87 deleted the docs/news-features-only branch August 10, 2026 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant