Add a script that generates a changelog from recent PRs and their labels

[emilk]

The script is scripts/generate_changelog.py and will do its best to organize a changelog based on PR labels

Checklist

• I have read and agree to Contributor Guide and the Code of Conduct

Output

🐍 Python SDK

• Expose all Rerun enums and types to main module scope #1598
• Make log_point more forgiving and update docstring #1663
• Add support for mesh vertex colors #1671
• Fix logging meshes without colors #1680

🦀 Rust SDK

• Refactor: re_sdk no longer depends on re_viewer #1507
• Refactor re_sdk::Session #1528
• Add support for mesh vertex colors #1671

🪳 Bug Fixes

• datastore: disable compaction (fixes 2x memory issue) #1535
• Fix garbage collection #1560
• Avoid using undefined extern "C" on windows #1577
• Fix crsh on decoding old .rrd files #1579
• datastore: stabilize dataframe sorts #1549
• Stop using infinities in wgsl shaders #1594
• Workaround for alpha to coverage state leaking on (Web)GL renderer #1596
• Use a patched wasm-bindgen-cli with fix for 2GiB bug #1605
• Misc: make example in log_pinhole runable #1609
• Early-out on zero-sized space-views to prevent crashes #1623
• Print our own callstack on panics #1622
• Handle ctrl+c to gracefully shutdown the server(s) #1613
• Fix crash on serve exit, second attempt #1633
• Fix wrong remove-tooltip for entities and groups #1637
• Fix requiring requiring focus for shutdown via ctrl+c when starting viewer from command line #1646
• Fix eye spin after eye reset #1652
• Fix crash on negative radii by instead warning #1654
• Fix crash when trying to listen on a taken TCP port #1650
• Don't show 2D labels in 3D space views. #1641
• Fix Z fighting with improved depth offset math #1661
• Whether a spatial view is 2d or 3d is now reevaluated over time unless picked explicitly #1660
• Update wgpu to v0.15.3 #1682
• Fix web crash on missing uniform buffer padding #1699
• Fix memory_usage example relying on implicit recursive features #1709
• Track changed state in nav mode combo box #1703
• Fix crash-on-save by switching file-picker dialog to xdg-portal #1402
• Change roll-shortcut from ALT to SHIFT #1715
• Fix CpuWriteGpuReadBelt producing unaligned gpu buffer offsets #1716

🚀 Performance Improvements

• Add re_arrow_store profile scopes #1546
• datastore: early exit missing components at table level #1554
• datastore: track bucket count in store stats & mem panel #1555
• LogDb: dont split on index bucket size #1558
• Introduce a simpler cache dedicated to just decode JPEGs #1550
• Implement outlines for points 2d/3d/depth & use them for select & hover in Viewer #1568
• Simplify ImageCache #1551
• New time panel density graph #1557
• Refactor the Arrow Mesh3D type to use zero-copy Buffers #1691
• Remove the redundant costly transform check during categorization #1695
• batching 3: DataRow & DataTable + no bundles outside of transport #1673

🧑‍🏫 Examples

• Very simple example streaming from an opencv camera #1502
• Initial TurtleBot subscriber demo #1523

📚 Docs

• Link to the Python SDK build instructions in rerun_py/README.md #1565

🖼 UI Improvements

• Fix combining outline mask for selection & hover #1552
• Implement outlines for rectangles & use them for select & hover of image primitives in Viewer #1559
• Show log messages in egui toast notifications #1603
• Adapt UI for smaller screens #1608
• Nicer toast notifications #1621
• Don't hover things in 2D/3D views if we are dragging something #1643
• Allow rolling 3D camera with primary mouse button + alt modifier #1659
• Name space views after the space and indicate duplicate names #1653
• Add banner about mobile browsers being unsupported #1674
• Improve ui for tensors and color map selection #1683
• Only show the mobile OS warning banner on web #1685
• Improve the depth backprojection feature #1690
• Swap overlay order of selection & hover outlines #1705
• Turn on depth cloud backprojection by default #1710
• Add radius boost for depth clouds on outline #1713

🤷‍♂️ Other Viewer Improvements

• Fix web feature name in error messages #1521
• Use outlines for mesh selections instead of highlight colors #1540
• Implement outlines for line renderer & use them for select & hover of "line-like" primitives in Viewer #1553
• Load .rrd file over HTTP #1600
• Revert "Handle ctrl+c to gracefully shutdown the server(s)" #1632
• More eager GC, and remove --fast-math optimization for wasm #1656
• Detect failure to install GUI log callback #1655
• Warn when most of the RAM has been used up by Rerun #1651
• Apply color maps to all types of depth tensors #1686
• Size boosted outlines for points & lines, color & size tweaking #1667
• Default point radius to 1.5 ui points #1706
• When streaming an rrd from http: play it, don't follow it #1707

🕸️ Web

• Use log as our log backend instead of tracing #1590
• Turn on allocation tracker at run-time and for web #1591
• Set correct MIME types in re_web_viewer_server #1602
• Upload web viewer to a bucket #1606
• Use hostname for default websocket address #1664
• Upload the colmap rrd file to gcloud #1666
• Show a warning by default on mobile browsers #1670
• Add analytics to the hosted index.html #1675
• Always upload latest prerelease to a dedicated prefix #1676
• Allow url param override on app.rerun.io #1678
• Show the git commit in the about section in pre-release builds #1677
• Update the web icon #1688

🎨 Renderer Improvements

• Outlines via masking & postprocessing in re_renderer #1532
• Add missing profiling scopes in re_renderer #1567
• Don't call wgpu::Device::poll on the web #1626
• Merge final outline render into composite step in order to fix blending #1629
• renderer: fix the groupby logic in mesh instancing #1657
• Fix outlines being offset diagonally by about half a pixel #1668
• Gpu readback belt for fast & easy data readback from gpu #1687
• Make CpuWriteGpuReadBelt texture copies easier/less error prone #1689

✨ Other Enhancement

• datastore: split out formatting & sanity checks in their own modules #1625
• Add rerun --save: stream incoming log stream to an rrd file #1662
• batching 1: introduce DataCell & retire ComponentBundle #1634
• Data store batching 2: split out component traits #1636

📈 Analytics

• Analytics: don't spam warning when there is an HTTP connection problem #1564
• Remove sensitive data from analytics #1563
• Analytics: Rename "location" to "file_line" in the "crash-panic" event #1575

🗣 Merged RFCs

• RFC: component-datatype conversions #1595
• RFC: pre-proposal for blueprint store #1582

🧑‍💻 Dev-experience

• Update rayon #1541
• Fix some 1.68 clippy lints #1569
• Remove duplicated 'nix' crate #1479
• Better MsgId format #1566
• Lint vertical spacing in Rust code #1572
• CI: Replace wasm_bindgen_check.sh with actually building the web-viewer #1604
• Add --all-features to Rust Analyzer flags #1624
• Run clippy for wasm, with own clippy.toml config file #1628
• Update tokio v1.24.1 -> v1.26.0 #1635
• Add a workflow input for running benchmarks manually #1698
• Add missing } to fix rust workflow #1700

🤷‍♂️ Other

• Clean up opencv_canny example slightly b487e550dcb87225858dc6f76b791a25e938e75e
• Lint fixes 9901e7c6735356b1970ddabc926bc5378d82e057
• Add a script that generates a changelog from recent PRs and their labels 9aad51443275aec58f75c549e0cfcdb38d657f29
• Fix typo 9e24e3f8d11fcc2cbdc949c6e8e8e64e09f9fb2a
• Add emojis for all categories, and list commits oldest -> newest c91b11b1016137a7cb62016cec1d65092bb8ad3a
• Cleanup bb658a055857c9b5ef52b50096382c5e6985083b

[Wumpf]

nice!

I'm wondering if it would be useful to show all labels as well since the changelog still needs quite a bit of manual work regardless and that can help in the process

[Wumpf]

I wonder if we should exclude regression tagged PRs 🤔
depends obv. for how long a thing regressed

[emilk]

You mean add a separate category for regression fixes?

[emilk]

I think adding labels add to much noise to the changelog:

🐍 Python SDK

• Expose all Rerun enums and types to main module scope #1598 (🐍 python API, 😤 annoying)
• Make log_point more forgiving and update docstring #1663 (🐍 python API)
• Add support for mesh vertex colors #1671 (🐍 python API, 🔺 re_renderer, 🦀 rust SDK, 📺 re_viewer)
• Fix logging meshes without colors #1680 (🐍 python API, 🦟 regression)

🦀 Rust SDK

• Refactor: re_sdk no longer depends on re_viewer #1507 (🦀 rust SDK, dogfooding, 📺 re_viewer)
• Refactor re_sdk::Session #1528 (🦀 rust SDK)
• Add support for mesh vertex colors #1671 (🐍 python API, 🔺 re_renderer, 🦀 rust SDK, 📺 re_viewer)

🪳 Bug Fixes

• datastore: disable compaction (fixes 2x memory issue) #1535 (🪳 bug, ⛃ re_datastore)
• Fix garbage collection #1560 (🪳 bug, ⛃ re_datastore, 📉 performance)
• Avoid using undefined extern "C" on windows #1577 (🪳 bug)
• Fix crsh on decoding old .rrd files #1579 (📺 re_viewer, 💣 crash)
• datastore: stabilize dataframe sorts #1549 (🪳 bug, ⛃ re_datastore, 😤 annoying)
• Stop using infinities in wgsl shaders #1594 (🪳 bug, 🕸️ web, 🔺 re_renderer)
• Workaround for alpha to coverage state leaking on (Web)GL renderer #1596 (🪳 bug, 🔺 re_renderer)
• Use a patched wasm-bindgen-cli with fix for 2GiB bug #1605 (🕸️ web, 💣 crash)
• Misc: make example in log_pinhole runable #1609 (🪳 bug, examples)
• Early-out on zero-sized space-views to prevent crashes #1623 (🪳 bug, 💣 crash)
• Print our own callstack on panics #1622 (enhancement, 🧑‍💻 dev experience, 💣 crash)
• Handle ctrl+c to gracefully shutdown the server(s) #1613 (🪳 bug, 💣 crash)
• Fix crash on serve exit, second attempt #1633 (📺 re_viewer, 💣 crash)
• Fix wrong remove-tooltip for entities and groups #1637 (🪳 bug, 📺 re_viewer)
• Fix requiring requiring focus for shutdown via ctrl+c when starting viewer from command line #1646 (🪳 bug, 📺 re_viewer, 🦟 regression)
• Fix eye spin after eye reset #1652 (🪳 bug, 📺 re_viewer)
• Fix crash on negative radii by instead warning #1654 (📺 re_viewer, 💣 crash)
• Fix crash when trying to listen on a taken TCP port #1650 (🪳 bug, 🦟 regression)
• Don't show 2D labels in 3D space views. #1641 (🪳 bug, 📺 re_viewer)
• Fix Z fighting with improved depth offset math #1661 (🪳 bug, 🔺 re_renderer, 📺 re_viewer)
• Whether a spatial view is 2d or 3d is now reevaluated over time unless picked explicitly #1660 (🪳 bug, 📺 re_viewer)
• Update wgpu to v0.15.3, fixing meshes on Windows Chrome #1682 (🪳 bug, 🕸️ web)
• Fix web crash on missing uniform buffer padding #1699 (🕸️ web, 🔺 re_renderer, 💣 crash, 🦟 regression)
• Fix memory_usage example relying on implicit recursive features #1709 (🪳 bug, 🧑‍💻 dev experience, 😤 annoying)
• Track changed state in nav mode combo box #1703 (🪳 bug, ui)
• Fix crash-on-save by switching file-picker dialog to xdg-portal #1402 (🪳 bug, 🛞 build wheels, 💣 crash)
• Change roll-shortcut from ALT to SHIFT #1715 (🪳 bug, ui, 📺 re_viewer)
• Fix CpuWriteGpuReadBelt producing unaligned gpu buffer offsets #1716 (🪳 bug, 🔺 re_renderer)

🚀 Performance Improvements

• Add re_arrow_store profile scopes #1546 (⛃ re_datastore, 📉 performance)
• datastore: early exit missing components at table level #1554 (⛃ re_datastore, 📉 performance)
• datastore: track bucket count in store stats & mem panel #1555 (🧑‍💻 dev experience, ⛃ re_datastore, 📉 performance)
• LogDb: dont split on index bucket size #1558 (⛃ re_datastore, 📉 performance)
• Introduce a simpler cache dedicated to just decode JPEGs #1550 (📉 performance)
• Implement outlines for points 2d/3d/depth & use them for select & hover in Viewer #1568 (🔺 re_renderer, 📺 re_viewer, 📉 performance)
• Simplify ImageCache #1551 (📉 performance)
• New time panel density graph #1557 (📺 re_viewer, 📉 performance)
• Refactor the Arrow Mesh3D type to use zero-copy Buffers #1691 (📉 performance)
• Remove the redundant costly transform check during categorization #1695 (📉 performance)
• batching 3: DataRow & DataTable + no bundles outside of transport #1673 (🏹 arrow, ⛃ re_datastore, 📉 performance)

🧑‍🏫 Examples

• Very simple example streaming from an opencv camera #1502 (examples)
• Initial TurtleBot subscriber demo #1523 (examples)

📚 Docs

• Link to the Python SDK build instructions in rerun_py/README.md #1565 (📖 documentation, 🧑‍💻 dev experience)

🖼 UI Improvements

• Fix combining outline mask for selection & hover #1552 (ui, 📺 re_viewer)
• Implement outlines for rectangles & use them for select & hover of image primitives in Viewer #1559 (ui, 🔺 re_renderer)
• Show log messages in egui toast notifications #1603 (ui, 📺 re_viewer)
• Adapt UI for smaller screens #1608 (🕸️ web, ui, 📺 re_viewer)
• Nicer toast notifications #1621 (ui, 📺 re_viewer)
• Don't hover things in 2D/3D views if we are dragging something #1643 (ui, 📺 re_viewer)
• Allow rolling 3D camera with primary mouse button + alt modifier #1659 (enhancement, ui, 📺 re_viewer)
• Name space views after the space and indicate duplicate names #1653 (ui)
• Add banner about mobile browsers being unsupported #1674 (ui)
• Improve ui for tensors and color map selection #1683 (ui, 📺 re_viewer)
• Only show the mobile OS warning banner on web #1685 (ui)
• Improve the depth backprojection feature #1690 (ui, 🔺 re_renderer, 📺 re_viewer)
• Swap overlay order of selection & hover outlines #1705 (ui, 📺 re_viewer)
• Turn on depth cloud backprojection by default #1710 (ui, 📺 re_viewer)
• Add radius boost for depth clouds on outline #1713 (ui, 🔺 re_renderer)

🤷‍♂️ Other Viewer Improvements

• Fix web feature name in error messages #1521 (📺 re_viewer, 😤 annoying, 🚜 refactor)
• Use outlines for mesh selections instead of highlight colors #1540 (🔺 re_renderer, 📺 re_viewer)
• Implement outlines for line renderer & use them for select & hover of "line-like" primitives in Viewer #1553 (🔺 re_renderer, 📺 re_viewer)
• Load .rrd file over HTTP #1600 (🕸️ web, 📺 re_viewer)
• Revert "Handle ctrl+c to gracefully shutdown the server(s)" #1632 (📺 re_viewer)
• More eager GC, and remove --fast-math optimization for wasm #1656 (enhancement, 🕸️ web, 📺 re_viewer)
• Detect failure to install GUI log callback #1655 (📺 re_viewer)
• Warn when most of the RAM has been used up by Rerun #1651 (📺 re_viewer)
• Apply color maps to all types of depth tensors #1686 (📺 re_viewer)
• Size boosted outlines for points & lines, color & size tweaking #1667 (🔺 re_renderer, 📺 re_viewer)
• Default point radius to 1.5 ui points #1706 (📺 re_viewer)
• When streaming an rrd from http: play it, don't follow it #1707 (📺 re_viewer)

🕸️ Web

• Use log as our log backend instead of tracing #1590 (🕸️ web, 🧑‍💻 dev experience)
• Turn on allocation tracker at run-time and for web #1591 (🕸️ web, 🧑‍💻 dev experience)
• Set correct MIME types in re_web_viewer_server #1602 (🕸️ web)
• Upload web viewer to a bucket #1606 (🕸️ web)
• Use hostname for default websocket address #1664 (🕸️ web)
• Upload the colmap rrd file to gcloud #1666 (🕸️ web)
• Show a warning by default on mobile browsers #1670 (🕸️ web)
• Add analytics to the hosted index.html #1675 (🕸️ web)
• Always upload latest prerelease to a dedicated prefix #1676 (🕸️ web, 🧑‍💻 dev experience)
• Allow url param override on app.rerun.io #1678 (🕸️ web)
• Show the git commit in the about section in pre-release builds #1677 (🕸️ web, 🧑‍💻 dev experience)
• Update the web icon #1688 (🕸️ web)

🎨 Renderer Improvements

• Outlines via masking & postprocessing in re_renderer #1532 (🔺 re_renderer)
• Add missing profiling scopes in re_renderer #1567 (🔺 re_renderer, 🧑‍💻 dev experience)
• Don't call wgpu::Device::poll on the web #1626 (🕸️ web, 🔺 re_renderer)
• Merge final outline render into composite step in order to fix blending #1629 (🔺 re_renderer)
• renderer: fix the groupby logic in mesh instancing #1657 (🔺 re_renderer)
• Fix outlines being offset diagonally by about half a pixel #1668 (🔺 re_renderer)
• Gpu readback belt for fast & easy data readback from gpu #1687 (🔺 re_renderer)
• Make CpuWriteGpuReadBelt texture copies easier/less error prone #1689 (🔺 re_renderer)

✨ Other Enhancement

• datastore: split out formatting & sanity checks in their own modules #1625 (enhancement, 🧑‍💻 dev experience, ⛃ re_datastore)
• Add rerun --save: stream incoming log stream to an rrd file #1662 (enhancement)
• batching 1: introduce DataCell & retire ComponentBundle #1634 (enhancement, 🏹 arrow, ⛃ re_datastore)
• Data store batching 2: split out component traits #1636 (enhancement, 🚜 refactor)

📈 Analytics

• Analytics: don't spam warning when there is an HTTP connection problem #1564 (📊 analytics)
• Remove sensitive data from analytics #1563 (🪳 bug, 📊 analytics)
• Analytics: Rename "location" to "file_line" in the "crash-panic" event #1575 (📊 analytics)

🗣 Merged RFCs

• RFC: component-datatype conversions #1595 (💬 discussion)
• RFC: pre-proposal for blueprint store #1582 (💬 discussion)

🧑‍💻 Dev-experience

• Update rayon #1541 (🧑‍💻 dev experience)
• Fix some 1.68 clippy lints #1569 (🧑‍💻 dev experience)
• Remove duplicated 'nix' crate #1479 (🧑‍💻 dev experience)
• Better MsgId format #1566 (🧑‍💻 dev experience)
• Lint vertical spacing in Rust code #1572 (🧑‍💻 dev experience, 🛑 controversial)
• CI: Replace wasm_bindgen_check.sh with actually building the web-viewer #1604 (🧑‍💻 dev experience)
• Add --all-features to Rust Analyzer flags #1624 (🧑‍💻 dev experience)
• Run clippy for wasm, with own clippy.toml config file #1628 (🧑‍💻 dev experience)
• Update tokio v1.24.1 -> v1.26.0 #1635 (🧑‍💻 dev experience)
• Add a workflow input for running benchmarks manually #1698 (🧑‍💻 dev experience)
• Add missing } to fix rust workflow #1700 (🧑‍💻 dev experience)

🤷‍♂️ Other

• Clean up opencv_canny example slightly b487e550dcb87225858dc6f76b791a25e938e75e
• Lint fixes 9901e7c6735356b1970ddabc926bc5378d82e057

[Wumpf]

Uh, yeah that's why too much. Looked at it more as a tool for manual improvement, but really we would need to establish a hierarchy of labels which we don't have :/