feat(releases): docs in a release display their action (added or changed)

[jordanl17]

…ged)

Description

What to review

Testing

Notes for release

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
page-building-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 24, 2024 3:11pm
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 24, 2024 3:11pm
test-compiled-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 24, 2024 3:11pm
test-next-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 24, 2024 3:11pm
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 24, 2024 3:11pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Oct 24, 2024 3:11pm

[github-actions]

No changes to documentation

[github-actions]

Component Testing Report Updated Oct 24, 2024 2:55 PM (UTC)

✅ All Tests Passed -- expand for details

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	1m 8s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	12s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	38s	6	0	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	52s	11	7	0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx	✅ Passed (Inspect)	0s	0	12	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	26s	6	0	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	14s	3	0	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	✅ Passed (Inspect)	3m 0s	0	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	1m 6s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	2m 45s	21	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 41s	18	0	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	13s	3	9	0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx	✅ Passed (Inspect)	40s	9	0	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	27s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	53s	12	0	0
formBuilder/tree-editing/TreeEditing.spec.tsx	✅ Passed (Inspect)	0s	0	3	0
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx	✅ Passed (Inspect)	0s	0	3	0

[github-actions]

⚡️ Editor Performance Report

Updated Thu, 24 Oct 2024 15:07:40 GMT

Benchmark	reference latency of sanity@latest	experiment latency of this branch	Δ (%) latency difference
article (title)	16.4 efps (61ms)	13.1 efps (77ms)	+16ms (+25.4%)	🔴
article (body)	55.9 efps (18ms)	56.7 efps (18ms)	-0ms (-1.4%)	✅
article (string inside object)	18.9 efps (53ms)	13.5 efps (74ms)	+21ms (+39.6%)	🔴
article (string inside array)	15.4 efps (65ms)	11.5 efps (87ms)	+22ms (+33.8%)	🔴
recipe (name)	30.3 efps (33ms)	20.4 efps (49ms)	+16ms (+48.5%)	🔴
recipe (description)	33.3 efps (30ms)	21.3 efps (47ms)	+17ms (+56.7%)	🔴
recipe (instructions)	99.9+ efps (6ms)	99.9+ efps (6ms)	+0ms (-/-%)	✅
synthetic (title)	15.2 efps (66ms)	5.9 efps (169ms)	+103ms (+155.3%)	🔴
synthetic (string inside object)	15.2 efps (66ms)	6.3 efps (158ms)	+92ms (+139.4%)	🔴

efps — editor "frames per second". The number of updates assumed to be possible within a second.

Derived from input latency. efps = 1000 / input_latency

Detailed information

🏠 Reference result

The performance result of sanity@latest

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	61ms	67ms	80ms	220ms	587ms	13.3s
article (body)	18ms	21ms	52ms	305ms	391ms	6.2s
article (string inside object)	53ms	58ms	68ms	137ms	215ms	8.4s
article (string inside array)	65ms	68ms	86ms	314ms	970ms	9.5s
recipe (name)	33ms	35ms	40ms	93ms	1ms	9.1s
recipe (description)	30ms	31ms	54ms	107ms	25ms	6.1s
recipe (instructions)	6ms	8ms	9ms	10ms	0ms	3.3s
synthetic (title)	66ms	70ms	77ms	362ms	1374ms	15.7s
synthetic (string inside object)	66ms	69ms	77ms	464ms	1617ms	10.3s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	77ms	87ms	103ms	375ms	2563ms	16.2s
article (body)	18ms	22ms	56ms	253ms	381ms	6.4s
article (string inside object)	74ms	76ms	94ms	320ms	2547ms	11.3s
article (string inside array)	87ms	90ms	96ms	361ms	3154ms	12.4s
recipe (name)	49ms	52ms	54ms	84ms	872ms	10.7s
recipe (description)	47ms	49ms	52ms	75ms	713ms	7.8s
recipe (instructions)	6ms	8ms	8ms	21ms	0ms	3.2s
synthetic (title)	169ms	178ms	343ms	1151ms	10154ms	27.7s
synthetic (string inside object)	158ms	165ms	174ms	868ms	8792ms	19.3s

📚 Glossary

column definitions

• benchmark — the name of the test, e.g. "article", followed by the label of the field being measured, e.g. "(title)".
• latency — the time between when a key was pressed and when it was rendered. derived from a set of samples. the median (p50) is shown to show the most common latency.
• p75 — the 75th percentile of the input latency in the test run. 75% of the sampled inputs in this benchmark were processed faster than this value. this provides insight into the upper range of typical performance.
• p90 — the 90th percentile of the input latency in the test run. 90% of the sampled inputs were faster than this. this metric helps identify slower interactions that occurred less frequently during the benchmark.
• p99 — the 99th percentile of the input latency in the test run. only 1% of sampled inputs were slower than this. this represents the worst-case scenarios encountered during the benchmark, useful for identifying potential performance outliers.
• blocking time — the total time during which the main thread was blocked, preventing user input and UI updates. this metric helps identify performance bottlenecks that may cause the interface to feel unresponsive.
• test duration — how long the test run took to complete.