Skip to content

docs: add spotlight#3833

Merged
mrlubos merged 1 commit intomainfrom
docs/spotlight
Apr 28, 2026
Merged

docs: add spotlight#3833
mrlubos merged 1 commit intomainfrom
docs/spotlight

Conversation

@mrlubos
Copy link
Copy Markdown
Member

@mrlubos mrlubos commented Apr 28, 2026

No description provided.

@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@mrlubos mrlubos marked this pull request as ready for review April 28, 2026 03:25
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 28, 2026

⚠️ No Changeset found

Latest commit: 17a586c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 28, 2026

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

Project Deployment Actions Updated (UTC)
hey-api-docs Ready Ready Preview, Comment Apr 28, 2026 3:26am

Request Review

@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. docs 📃 Documentation updates. labels Apr 28, 2026
@pullfrog
Copy link
Copy Markdown
Contributor

pullfrog Bot commented Apr 28, 2026

TL;DR — Adds a "Spotlight" section to GitHub release notes that highlights community contributors. The content lives in a markdown file (.release/spotlight.md) that gets prepended to release notes during assembly and then deleted on publish.

Key changes

  • Add spotlight section to release notes — Reads .release/spotlight.md at build time and prepends its content (with a separator) to the formatted release notes.
  • Auto-clean spotlight file on release — The release workflow deletes spotlight.md after changelog assembly and commits the removal alongside the changelog sync.

Summary | 4 files | 1 commit | base: maindocs/spotlight


Spotlight content in release notes

Before: Release notes contained only package changelogs, sponsors, and contributor lists.
After: An optional spotlight block (from .release/spotlight.md) is prepended to release notes when the file exists and has content.

The formatReleaseNotes function in release-notes.ts now reads SPOTLIGHT_PATH inside a try/catch — if the file exists and is non-empty, its content is pushed to the output followed by a --- separator. The initial spotlight thanks @SukkaW for 10x–30x performance improvements on large specs.

.release/spotlight.md · scripts/changelog/release-notes.ts · .github/workflows/release.yml

Pullfrog  | View workflow run | via Pullfrog𝕏

Copy link
Copy Markdown
Contributor

@pullfrog pullfrog Bot left a comment

Choose a reason for hiding this comment

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

Reviewed — no issues found.

Task list (3/3 completed)
  • Read the full diff to understand all changes
  • Examine each changed file in detail
  • Self-critique and submit review

Pullfrog  | View workflow run𝕏

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 39.58%. Comparing base (9c39919) to head (17a586c).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3833   +/-   ##
=======================================
  Coverage   39.58%   39.58%           
=======================================
  Files         532      532           
  Lines       19580    19580           
  Branches     5829     5829           
=======================================
  Hits         7751     7751           
  Misses       9581     9581           
  Partials     2248     2248           
Flag Coverage Δ
unittests 39.58% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mrlubos mrlubos merged commit 6bb7660 into main Apr 28, 2026
11 checks passed
@mrlubos mrlubos deleted the docs/spotlight branch April 28, 2026 03:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 📃 Documentation updates. size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant