Skip to content

Commit 17a586c

Browse files
committed
docs: add spotlight
1 parent 9c39919 commit 17a586c

4 files changed

Lines changed: 21 additions & 1 deletion

File tree

.github/workflows/release.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,17 @@ jobs:
101101
if: steps.changesets.outputs.published == 'true'
102102
run: pnpm changelog:assemble
103103

104+
- name: Delete spotlight
105+
if: steps.changesets.outputs.published == 'true'
106+
run: rm -f .release/spotlight.md
107+
104108
- name: Commit changelog
105109
if: steps.changesets.outputs.published == 'true'
106110
uses: stefanzweifel/git-auto-commit-action@v7.1.0
107111
with:
108112
branch: ${{ env.CURRENT_BRANCH }}
109113
commit_message: 'chore: sync changelog [skip ci]'
110-
file_pattern: CHANGELOG.md
114+
file_pattern: CHANGELOG.md .release/spotlight.md
111115

112116
- name: Update lock file
113117
if: env.CURRENT_BRANCH == 'changeset-release/main'

.release/.gitkeep

Whitespace-only changes.

.release/spotlight.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Spotlight
2+
3+
A huge thank you to **@SukkaW** this release! He noticed generation was painfully slow on large OpenAPI specs, traced it to several algorithmic bottlenecks, and fixed them. The result is a 10x-30x performance gain on larger specs, with meaningful improvements on smaller specs as well.
4+
5+
We sent him $100 as a small token of appreciation.
6+
7+
[Contribute →](https://heyapi.dev/openapi-ts/community/contributing)

scripts/changelog/release-notes.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ import { readAllPackageChangelogs } from './reader';
99
import { createReleases } from './releases';
1010
import type { Contributor, Release } from './types';
1111

12+
const SPOTLIGHT_PATH = '.release/spotlight.md';
13+
1214
function getSponsorsBlock(): string | undefined {
1315
try {
1416
const sponsorsTable = fs.readFileSync(SPONSORS_TABLE_GOLD_PATH, 'utf-8').trim();
@@ -32,6 +34,13 @@ function getSponsorsBlock(): string | undefined {
3234
function formatReleaseNotes(release: Release, contributors: Array<Contributor>): string {
3335
const lines: Array<string> = [];
3436

37+
try {
38+
const content = fs.readFileSync(SPOTLIGHT_PATH, 'utf-8').trim();
39+
if (content) lines.push(content, '---', '');
40+
} catch {
41+
// noop
42+
}
43+
3544
for (const pkg of release.packages.filter((p) => p.hasUserFacingChanges)) {
3645
formatReleasePackage(pkg, lines);
3746
lines.push('---', '');

0 commit comments

Comments
 (0)