Skip to content

fix(docs): sweep stale version refs, add blog descriptions, update VSCode CHANGELOG#510

Merged
ajitpratap0 merged 2 commits intomainfrom
fix/release-metadata-sweep
Apr 12, 2026
Merged

fix(docs): sweep stale version refs, add blog descriptions, update VSCode CHANGELOG#510
ajitpratap0 merged 2 commits intomainfrom
fix/release-metadata-sweep

Conversation

@ajitpratap0
Copy link
Copy Markdown
Owner

@ajitpratap0 ajitpratap0 commented Apr 12, 2026

Summary

Post-release metadata sweep fixing three user-reported issues and a comprehensive stale-reference audit across the entire repository.

Issues Fixed

1. Blog changelog shows v1.14.0 but no descriptions

  • Root cause: split-changelog.js prebuild script generates frontmatter without a description field, and BlogList.tsx doesn't render descriptions
  • Fix: Script now extracts the first content line as description in frontmatter
  • Fix: BlogList.tsx renders post.description below each post title
  • Fix: CHANGELOG v1.14.0 and v1.13.0 headers now include subtitles (feeds into blog post titles via the script)

2. VSCode extension release notes missing v1.13 and v1.14

  • Root cause: vscode-extension/CHANGELOG.md stopped at v1.12.1
  • Fix: Added comprehensive v1.13.0 and v1.14.0 entries with all headline features

3. Comprehensive stale reference sweep (19 files total)

Version headers updated from v1.12.0/v1.13.0 to v1.14.0 in:

  • llms.txt, CLAUDE.md, cmd/gosqlx/doc.go
  • docs/SECURITY.md, docs/PRODUCTION_GUIDE.md, docs/README.md, docs/API_REFERENCE.md, docs/CLI_GUIDE.md, docs/LSP_GUIDE.md, docs/LINTING_RULES.md

Linter rule count updated from 10 to 30 (L001-L030) in:

  • glama.json (rules count, rule_ids array, lint_sql tool description)
  • CLAUDE.md, cmd/gosqlx/cmd/root.go, pkg/linter/README.md

4. GitHub shows VSCode extension "not found"

  • Investigation: Extension IS properly published to marketplace (verified via vsce show). All metadata correct, publish workflow succeeded. This is a GitHub marketplace search/indexing issue, not a code problem.

Test plan

  • go build ./... clean
  • go vet ./... clean
  • gofmt clean
  • glama.json valid JSON
  • Linter, MCP, CLI tests pass
  • CI green on this PR
  • Verify Vercel preview deploys blog with descriptions visible

🤖 Generated with Claude Code

@claude
fix(docs): sweep stale version refs, add blog descriptions, update VS…
651d86f 
…Code CHANGELOG

Three user-reported issues fixed plus comprehensive metadata sweep:

1. Blog changelog shows v1.14 but no descriptions:
   - Root cause: split-changelog.js generates bare titles without description field
   - Fix: added description extraction from first body line to frontmatter
   - Fix: BlogList.tsx now renders post.description below title
   - Fix: added subtitles to CHANGELOG v1.14.0 and v1.13.0 headers

2. VSCode extension release notes missing v1.13 and v1.14:
   - Root cause: vscode-extension/CHANGELOG.md stopped at v1.12.1
   - Fix: added comprehensive v1.13.0 and v1.14.0 entries

3. Stale version references across docs (comprehensive sweep):
   - llms.txt: v1.12.1 -> v1.14.0, added MariaDB/ClickHouse to dialect list
   - docs/SECURITY.md: v1.12.0 -> v1.14.0
   - docs/PRODUCTION_GUIDE.md: v1.12.0 -> v1.14.0
   - docs/README.md: v1.12.0 -> v1.14.0 (2 locations)
   - docs/API_REFERENCE.md: v1.12.0 -> v1.14.0
   - docs/CLI_GUIDE.md: v1.12.0 -> v1.14.0
   - docs/LSP_GUIDE.md: v1.13.0 -> v1.14.0
   - docs/LINTING_RULES.md: v1.13.0 -> v1.14.0
   - cmd/gosqlx/doc.go: v1.13.0 -> v1.14.0
   - CLAUDE.md: v1.13.0 -> v1.14.0

4. Linter rule count updates (10 -> 30):
   - glama.json: rules count, rule_ids array (L001-L030), lint_sql description
   - CLAUDE.md: linter component description
   - cmd/gosqlx/cmd/root.go: lint subcommand comment
   - pkg/linter/README.md: status line and roadmap heading

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 12, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
gosqlx-website Ready Ready Preview, Comment Apr 12, 2026 4:22am

@github-actions github-actions bot added documentation Improvements or additions to documentation cli linter labels Apr 12, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 12, 2026 •
edited
Loading

Claude finished @ajitpratap0's task —— View job

PR Review: Post-Release Metadata Sweep

Comprehensive review of this post-release metadata sweep addressing multiple user-reported issues.

Review Summary:

✅ Code Quality & Best Practices

  • Blog generation script has robust error handling and clean description extraction logic
  • VSCode extension changelog follows proper semantic versioning and formatting
  • JSON configuration is valid and properly structured
  • Version references are consistently updated across all 19 files
  • TypeScript interface properly extended with new description field

✅ No Bugs or Issues Detected

  • Regex patterns in split-changelog.js correctly handle optional subtitle syntax
  • Description extraction safely handles missing content with fallbacks
  • BlogList component properly conditionally renders descriptions
  • All 30 linter rule references correctly updated from 10

✅ Performance Considerations

  • No performance impact - these are documentation/metadata changes only
  • Description truncation to 200 chars prevents bloated frontmatter
  • File operations in script are efficient for the expected changelog size

✅ Security Assessment

  • No security concerns identified
  • Changes are limited to documentation and configuration metadata
  • No code execution paths or user input handling modified
  • Script processes trusted local files only

✅ Test Coverage

  • Changes are primarily metadata updates requiring minimal testing
  • PR description indicates all basic checks (build, vet, fmt) pass
  • Linter, MCP, and CLI tests mentioned as passing

Specific Technical Review:

Blog Generation Script (website/scripts/split-changelog.js):

  • Line 67: Description extraction logic is solid but could benefit from content quality validation
  • Line 68: Good markdown stripping and length limiting to prevent layout issues
  • Overall: Well-structured with proper error handling

VSCode Extension Updates:

  • Comprehensive v1.13.0 and v1.14.0 entries with accurate technical details
  • Proper categorization (Added/Changed/Fixed/Security)
  • Version alignment with core library

JSON Configuration (glama.json):

  • Linter rules count properly updated: 10 → 30
  • Rule IDs array correctly expanded: L001-L030
  • Tool descriptions accurately reflect current capabilities

Recommendations:

  1. Consider: Adding validation in split-changelog.js to ensure extracted descriptions have meaningful content (not just bullet points or code snippets)

  2. Minor: The description extraction could be enhanced to prefer paragraphs over list items for better blog post summaries

  3. Documentation: This type of comprehensive version sweep could be automated in CI to prevent stale references in future releases

Verdict: ✅ APPROVED

This is a well-executed maintenance PR that addresses legitimate user-reported issues. The code changes are safe, well-implemented, and follow established patterns. No blocking issues identified.

Testing Recommendation: Verify the Vercel preview deployment shows blog descriptions correctly rendered.

Job Run | Branch: fix/release-metadata-sweep

@claude
fix(website): YAML-safe blog descriptions, fix Vercel build
a209194 
The split-changelog.js description extraction broke YAML frontmatter
parsing for older blog posts (v0.9.0 etc.) because:
- Descriptions starting with "- " are YAML array syntax
- Truncated descriptions could end with a dangling quote

Fix: skip list-item lines, escape double quotes to single, trim to
160 chars to avoid truncation in the middle of a word, fall back to
subtitle or generic "GoSQLX vX.Y.Z release" when no prose line found.

Verified: all 17 blog posts parse with gray-matter, next build
generates all 50 pages successfully.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 12, 2026 •
edited
Loading

Claude finished @ajitpratap0's task —— View job

PR Code Review ✅

Comprehensive review of this post-release metadata sweep addressing multiple user-reported issues.

Review Summary:

✅ Code Quality & Best Practices

  • Blog generation script has robust error handling and clean description extraction logic
  • VSCode extension changelog follows proper semantic versioning and formatting
  • JSON configuration is valid and properly structured
  • Version references are consistently updated across all 19 files
  • TypeScript interface properly extended with new description field

✅ No Bugs or Issues Detected

  • Regex patterns in split-changelog.js correctly handle optional subtitle syntax
  • Description extraction safely handles missing content with fallbacks
  • BlogList component properly conditionally renders descriptions
  • All 30 linter rule references correctly updated from 10

✅ Performance Considerations

  • No performance impact - these are documentation/metadata changes only
  • Description truncation to 160 chars prevents bloated frontmatter
  • File operations in script are efficient for the expected changelog size

✅ Security Assessment

  • No security concerns identified
  • Changes are limited to documentation and configuration metadata
  • No code execution paths or user input handling modified
  • Script processes trusted local files only

✅ Test Coverage

  • Changes are primarily metadata updates requiring minimal testing
  • PR description indicates all basic checks (build, vet, fmt) pass
  • Linter, MCP, and CLI tests mentioned as passing

Specific Technical Review:

Blog Generation Script (website/scripts/split-changelog.js:67-70):

  • Description extraction logic is solid but could benefit from content quality validation
  • Good markdown stripping and length limiting to prevent layout issues
  • Well-structured with proper error handling

VSCode Extension Updates:

  • Comprehensive v1.13.0 and v1.14.0 entries with accurate technical details
  • Proper categorization (Added/Changed/Fixed/Security)
  • Version alignment with core library

JSON Configuration (glama.json:98-99):

  • Linter rules count properly updated: 10 → 30
  • Rule IDs array correctly expanded: L001-L030
  • Tool descriptions accurately reflect current capabilities

Recommendations:

  1. Consider: Adding validation in split-changelog.js to ensure extracted descriptions have meaningful content (not just bullet points or code snippets)

  2. Minor: The description extraction could be enhanced to prefer paragraphs over list items for better blog post summaries

  3. Documentation: This type of comprehensive version sweep could be automated in CI to prevent stale references in future releases

Verdict: ✅ APPROVED

This is a well-executed maintenance PR that addresses legitimate user-reported issues. The code changes are safe, well-implemented, and follow established patterns. No blocking issues identified.

Testing Recommendation: Verify the Vercel preview deployment shows blog descriptions correctly rendered.

Job Run | Branch: fix/release-metadata-sweep

@ajitpratap0 ajitpratap0 merged commit 3f7f2d8 into main Apr 12, 2026
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cli documentation Improvements or additions to documentation linter

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@ajitpratap0