Skip to content

fix(app): require app update notice section - #153

Merged
Astro-Han merged 2 commits into
devfrom
fix/i124-update-notice
Apr 22, 2026
Merged

fix(app): require app update notice section#153
Astro-Han merged 2 commits into
devfrom
fix/i124-update-notice

Conversation

@Astro-Han

@Astro-Han Astro-Han commented Apr 22, 2026

Copy link
Copy Markdown
Owner

Summary

Require GitHub Release bodies to provide a dedicated ## App Update Notice section before the in-app post-update modal shows release text. Bump release package versions to 0.2.6.

Why

Fixes #124. The previous parser picked the first non-heading line from the general GitHub Release body, so a Downloads link could appear as the user-facing update notice. The app now avoids guessing from Downloads, Highlights, Verification, or maintenance sections.

Related Issue

Fixes #124

How To Verify

bun --cwd packages/app test src/context/highlights.test.ts
bun --cwd packages/app typecheck
bun install --frozen-lockfile

Also ran fresh-eyes code review with no Critical, Important, or worth-fixing Minor findings.

Screenshots or Recordings

Not included. This changes release-note parsing behavior and release metadata, with no visible UI layout change in this branch.

Checklist

  • I linked the related issue, or stated why there is no issue
  • This PR has type, scope, and priority labels, or I requested maintainer labeling
  • I listed the relevant verification steps, including tests when behavior changed
  • I manually checked visible UI or copy changes when needed, with screenshots or recordings
  • I considered macOS and Windows impact for desktop, packaging, updater, signing, paths, shell, or permissions changes
  • I called out docs, release notes, dependencies, permissions, credentials, deletion behavior, or generated/local file changes when relevant
  • I am targeting dev, and my PR title and commit messages use Conventional Commits in English

Summary by CodeRabbit

  • Chores
    • Bumped version to 0.2.6 across all packages.
    • Improved in-app update notice generation from release information.

@Astro-Han Astro-Han added bug Something isn't working P2 Medium priority app Application behavior and product flows labels Apr 22, 2026
@coderabbitai

coderabbitai Bot commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@Astro-Han has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 44 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 10 minutes and 44 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: e10d121f-6d8a-48c4-8389-8adba45ad76c

📥 Commits

Reviewing files that changed from the base of the PR and between 240c432 and e8aba7a.

⛔ Files ignored due to path filters (1)
  • bun.lock is excluded by !**/*.lock
📒 Files selected for processing (7)
  • .github/RELEASE_CHECKLIST.md
  • packages/app/package.json
  • packages/app/src/context/highlights.test.ts
  • packages/app/src/context/highlights.tsx
  • packages/desktop-electron/package.json
  • packages/opencode/package.json
  • packages/util/package.json
📝 Walkthrough

Walkthrough

This PR implements a fix for a bug where post-update modals displayed raw Markdown download links by introducing a dedicated "## App Update Notice" section in GitHub releases. The app's release notes parser now extracts content exclusively from this section, preventing fallback to generic release body content. Version bumps to 0.2.6 across all workspace packages and release checklist documentation is updated accordingly.

Changes

Cohort / File(s) Summary
Release Documentation
.github/RELEASE_CHECKLIST.md
Added "App Update Notice" section to release checklist specifying product-facing content requirements for in-app modal (short sentences only; no download links, PRs, verification, or maintenance notes).
Version Bumps
packages/app/package.json, packages/desktop-electron/package.json, packages/opencode/package.json, packages/util/package.json
Updated version field from 0.2.5 to 0.2.6 across all workspace packages.
Release Highlights Parser
packages/app/src/context/highlights.tsx
Replaced generic summarizeBody() with targeted findAppUpdateNotice() and summarizeAppUpdateNotice() functions. Parser now locates markdown heading matching ##-###### followed by "App Update Notice", extracts that section until the next equal-or-higher-level heading, filters out empty lines and heading markers, and returns the first non-heading line trimmed to 200 characters.
Parser Tests
packages/app/src/context/highlights.test.ts
Updated test fixtures to include "## App Update Notice" section in mock release bodies. Added test case for missing section to ensure no highlights are produced without it. Adjusted truncation test to wrap content under the new section.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested labels

P1, desktop

Poem

🐰 A notice now clean, no download in sight,
Just words of the updates, honest and bright,
No links or tech jargon to confuse the kind user,
The modal's reborn—now that's quite the booster!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix(app): require app update notice section' directly describes the main change: implementing a requirement for the 'App Update Notice' section in release parsing.
Description check ✅ Passed The description fully covers all template sections: Summary, Why, Related Issue, How To Verify, Screenshots or Recordings, and Checklist with all items marked complete.
Linked Issues check ✅ Passed The PR successfully implements the core requirement from issue #124: requiring a dedicated '## App Update Notice' section and preventing fallback to the general release body, with updated tests validating the new behavior.
Out of Scope Changes check ✅ Passed All changes are in scope: release parsing logic, tests, release checklist documentation, and version bumps to 0.2.6 across all packages are all aligned with fixing issue #124.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/i124-update-notice

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

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request updates the project version to 0.2.6 across multiple packages and introduces logic to extract a specific 'App Update Notice' section from GitHub release bodies. The changes include updates to the release checklist, package manifests, and the implementation of a section-finding utility with associated unit tests. A review comment identifies a potential issue with the regex used to detect markdown headings, recommending a more inclusive pattern to ensure the parser correctly identifies section boundaries even when headings are empty or contain only whitespace.

Comment thread packages/app/src/context/highlights.tsx Outdated
@Astro-Han
Astro-Han force-pushed the fix/i124-update-notice branch from 240c432 to e8aba7a Compare April 22, 2026 17:01
@Astro-Han
Astro-Han merged commit 3ff9c0b into dev Apr 22, 2026
23 checks passed
@Astro-Han
Astro-Han deleted the fix/i124-update-notice branch April 22, 2026 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

app Application behavior and product flows bug Something isn't working P2 Medium priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] Update notice shows raw release download link

1 participant