chore: Update documentation for publishing and fix changelog formatting [DT-9260]

.github/workflows/release.yml

@@ -76,6 +76,9 @@ jobs:
               env:
                   OUTPUT: packages/${{ inputs.package }}/CHANGELOG.md
 
+            - name: Format changelog
+              run: pnpm exec oxfmt "packages/${{ inputs.package }}/CHANGELOG.md"
+
             - name: Commit package.json and changelog
               run: |
                   git add "packages/${{ inputs.package }}/package.json" \

packages/core/changelog.md → packages/core/CHANGELOG.md

@@ -6,22 +6,19 @@ All notable changes to this project will be documented in this file.
 
 ### 🚀 Features
 
-- Package tag changelog generation
+- Package tag changelog generation [DT-9260] ([#179](https://github.com/AllenInstitute/vis/pull/179))
 
 ### 🐛 Bug Fixes
 
 - Allow Workers to be instantiated directly via callback ([#206](https://github.com/AllenInstitute/vis/pull/206))
-- Fix version display on changelogs and tweak scatterbrain package command
 
 ### 💼 Other
 
-- Don't filter out unconvenctional commits so we can see everything!
-- Merge branch 'main' into lane/package-tag-changelogs
-- Merge branch 'main' into lane/package-tag-changelogs
-- Merge branch 'main' into lane/package-tag-changelogs
-- Tag scattebrain to make sure it was working
 - Slight changes to the CacheClient interface ([#253](https://github.com/AllenInstitute/vis/pull/253))
-- Merge branch 'main' into lane/package-tag-changelogs
+- Fix name of file on changelog command
+- Make changelog files uppercase
+- Add fmt to changelog production command
+- Do git stuff to make sure it's actually changing the file name
 
 ### ⚙️ Miscellaneous Tasks
 
@@ -37,6 +34,8 @@ All notable changes to this project will be documented in this file.
 - _(deps)_ Bump lodash and @types/lodash ([#236](https://github.com/AllenInstitute/vis/pull/236))
 - NPM registry [DT-9193] ([#241](https://github.com/AllenInstitute/vis/pull/241))
 - _(deps)_ Bump @biomejs/biome from 2.4.4 to 2.4.9 ([#245](https://github.com/AllenInstitute/vis/pull/245))
+- Migrate to oxfmt ([#247](https://github.com/AllenInstitute/vis/pull/247))
+- _(deps)_ Bump lodash from 4.17.23 to 4.18.1 ([#248](https://github.com/AllenInstitute/vis/pull/248))
 
 ## [0.0.4] - 2025-07-14
 

packages/core/package.json

@@ -42,7 +42,7 @@
         "test": "vitest --watch",
         "test:ci": "vitest run",
         "coverage": "vitest run --coverage",
-        "changelog": "git-cliff -o changelog.md --tag-pattern @alleninstitute/vis-core@*"
+        "changelog": "git-cliff -o CHANGELOG.md --tag-pattern @alleninstitute/vis-core@* && oxfmt CHANGELOG.md"
     },
     "repository": {
         "type": "git",

packages/dzi/changelog.md → packages/dzi/CHANGELOG.md

@@ -7,20 +7,14 @@ All notable changes to this project will be documented in this file.
 ### 🚀 Features
 
 - DZI fetch function ([#162](https://github.com/AllenInstitute/vis/pull/162))
-- Package tag changelog generation
-
-### 🐛 Bug Fixes
-
-- Fix version display on changelogs and tweak scatterbrain package command
+- Package tag changelog generation [DT-9260] ([#179](https://github.com/AllenInstitute/vis/pull/179))
 
 ### 💼 Other
 
-- Don't filter out unconvenctional commits so we can see everything!
-- Merge branch 'main' into lane/package-tag-changelogs
-- Merge branch 'main' into lane/package-tag-changelogs
-- Merge branch 'main' into lane/package-tag-changelogs
-- Tag scattebrain to make sure it was working
-- Merge branch 'main' into lane/package-tag-changelogs
+- Fix name of file on changelog command
+- Make changelog files uppercase
+- Add fmt to changelog production command
+- Do git stuff to make sure it's actually changing the file name
 
 ### ⚙️ Miscellaneous Tasks
 
@@ -35,6 +29,7 @@ All notable changes to this project will be documented in this file.
 - Renaming render functions from "renderer" to "render command" ([#204](https://github.com/AllenInstitute/vis/pull/204))
 - Update or remove dependencies ([#229](https://github.com/AllenInstitute/vis/pull/229))
 - NPM registry [DT-9193] ([#241](https://github.com/AllenInstitute/vis/pull/241))
+- Migrate to oxfmt ([#247](https://github.com/AllenInstitute/vis/pull/247))
 
 ## [0.0.11] - 2025-04-08
 
@@ -71,12 +66,39 @@ All notable changes to this project will be documented in this file.
 - Dependency health configurations ([#17](https://github.com/AllenInstitute/vis/pull/17))
 - Clean up dependencies [DT-7060] ([#55](https://github.com/AllenInstitute/vis/pull/55))
 - Fix all but non-null assertion lints ([#96](https://github.com/AllenInstitute/vis/pull/96))
-- Logger with log levels ([#97](https://github.com/AllenInstitute/vis/pull/97))
-- Test coverage tooling ([#95](https://github.com/AllenInstitute/vis/pull/95))
-- Updating vis-dzi and vis-omezarr to enable use of vis-scatterbrain 0.0.10 ([#112](https://github.com/AllenInstitute/vis/pull/112))
-- Rename vis-scatterbrain package to vis-core ([#118](https://github.com/AllenInstitute/vis/pull/118))
-- Add helpful linting rules ([#127](https://github.com/AllenInstitute/vis/pull/127))
-- Dev command, reorganized docs, added stubs ([#163](https://github.com/AllenInstitute/vis/pull/163))
-- _(deps)_ Bump @biomejs/biome from 1.9.4 to 2.0.6 ([#174](https://github.com/AllenInstitute/vis/pull/174))
+
+## [0.0.7] - 2025-02-03
+
+### ⚙️ Miscellaneous Tasks
+
+- Remove only-allow so builds stop failing ([#47](https://github.com/AllenInstitute/vis/pull/47))
+- Version bumps for only-allow removal release ([#51](https://github.com/AllenInstitute/vis/pull/51))
+
+## [0.0.6] - 2024-12-04
+
+### 💼 Other
+
+- Noah/documentation ([#46](https://github.com/AllenInstitute/vis/pull/46))
+
+## [0.0.5] - 2024-11-21
+
+### 🐛 Bug Fixes
+
+- Dzi viewer would loop forever due to some faulty math ([#43](https://github.com/AllenInstitute/vis/pull/43))
+
+## [0.0.4] - 2024-11-13
+
+### ⚙️ Miscellaneous Tasks
+
+- CI workflow [DT-5996] ([#25](https://github.com/AllenInstitute/vis/pull/25))
+- Update version ([#39](https://github.com/AllenInstitute/vis/pull/39))
+
+## [0.0.3] - 2024-10-02
+
+### 💼 Other
+
+- DZI viewer component ([#29](https://github.com/AllenInstitute/vis/pull/29))
+
+Co-authored-by: Lane Sawyer <lane.sawyer@alleninstitute.org>
 
 <!-- generated by git-cliff -->

packages/dzi/package.json

@@ -38,7 +38,7 @@
         "test": "vitest --watch",
         "test:ci": "vitest run",
         "coverage": "vitest run --coverage",
-        "changelog": "git-cliff -o changelog.md --tag-pattern @alleninstitute/vis-dzi@*"
+        "changelog": "git-cliff -o CHANGELOG.md --tag-pattern @alleninstitute/vis-dzi@* && oxfmt CHANGELOG.md"
     },
     "repository": {
         "type": "git",

packages/geometry/CHANGELOG.md

@@ -0,0 +1,208 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### 🚀 Features
+
+- Package tag changelog generation [DT-9260] ([#179](https://github.com/AllenInstitute/vis/pull/179))
+
+### 💼 Other
+
+- Basic 3D Math utils ([#170](https://github.com/AllenInstitute/vis/pull/170))
+- Scatterbrain rendering in vis, including shader generation ([#223](https://github.com/AllenInstitute/vis/pull/223))
+
+Co-authored-by: Lane Sawyer <lane.sawyer@alleninstitute.org>
+
+- Fix name of file on changelog command
+- Make changelog files uppercase
+- Add fmt to changelog production command
+- Do git stuff to make sure it's actually changing the file name
+
+### ⚙️ Miscellaneous Tasks
+
+- Add helpful linting rules ([#127](https://github.com/AllenInstitute/vis/pull/127))
+- Dev command, reorganized docs, added stubs ([#163](https://github.com/AllenInstitute/vis/pull/163))
+- _(deps)_ Bump @biomejs/biome from 1.9.4 to 2.0.6 ([#174](https://github.com/AllenInstitute/vis/pull/174))
+- Add Changelogs ([#117](https://github.com/AllenInstitute/vis/pull/117))
+- Update release numbers for release ([#180](https://github.com/AllenInstitute/vis/pull/180))
+- _(deps)_ Bump @biomejs/biome from 2.1.3 to 2.2.2 ([#190](https://github.com/AllenInstitute/vis/pull/190))
+- Adding "type: module" to all packages ([#201](https://github.com/AllenInstitute/vis/pull/201))
+- Adding in a caching multithreaded Fetch Store ([#200](https://github.com/AllenInstitute/vis/pull/200))
+- Update or remove dependencies ([#229](https://github.com/AllenInstitute/vis/pull/229))
+- Quick version bump (which I forgot) ([#231](https://github.com/AllenInstitute/vis/pull/231))
+- NPM registry [DT-9193] ([#241](https://github.com/AllenInstitute/vis/pull/241))
+- Migrate to oxfmt ([#247](https://github.com/AllenInstitute/vis/pull/247))
+
+## [0.0.6] - 2025-04-08
+
+### 🚀 Features
+
+- Support for arbitrary color channels in OME-Zarr images [DC-530] ([#123](https://github.com/AllenInstitute/vis/pull/123))
+
+### ⚙️ Miscellaneous Tasks
+
+- Test coverage tooling ([#95](https://github.com/AllenInstitute/vis/pull/95))
+- Updates to package versions for Core, Geometry, OmeZarr + examples [DC-530] ([#124](https://github.com/AllenInstitute/vis/pull/124))
+
+## [0.0.5] - 2025-03-28
+
+### 🐛 Bug Fixes
+
+- Remove non-null assertions ([#101](https://github.com/AllenInstitute/vis/pull/101))
+
+### ⚙️ Miscellaneous Tasks
+
+- Update Vis OME-Zarr package to load the full set of metadata available in Zarr files [DT-7615] ([#103](https://github.com/AllenInstitute/vis/pull/103))
+
+## [0.0.4] - 2025-03-14
+
+### 🐛 Bug Fixes
+
+- CI tests weren't running [DT-7060] ([#87](https://github.com/AllenInstitute/vis/pull/87))
+
+### 💼 Other
+
+- March 2025 ([#99](https://github.com/AllenInstitute/vis/pull/99))
+
+### ⚙️ Miscellaneous Tasks
+
+- Install Biome, fix formatting [DT-7060] ([#52](https://github.com/AllenInstitute/vis/pull/52))
+- Biome linting with auto-fixes [DT-7060] ([#53](https://github.com/AllenInstitute/vis/pull/53))
+- Dependency health configurations ([#17](https://github.com/AllenInstitute/vis/pull/17))
+- Clean up dependencies [DT-7060] ([#55](https://github.com/AllenInstitute/vis/pull/55))
+- Fix all but non-null assertion lints ([#96](https://github.com/AllenInstitute/vis/pull/96))
+
+## [0.0.3] - 2025-02-03
+
+### 🚀 Features
+
+- _(geometry)_ LineSegmentsIntersect and det ([#21](https://github.com/AllenInstitute/vis/pull/21))
+
+### 🐛 Bug Fixes
+
+- Expose Rectangle2D functions, remove glob export from Interval ([#13](https://github.com/AllenInstitute/vis/pull/13))
+
+### 💼 Other
+
+- Merge pull request [#12](https://github.com/AllenInstitute/vis/pull/12) from AllenInstitute/noah/limit-queue-time
+
+dont hog the main thread - use a soft limit
+
+- Cache limits ([#14](https://github.com/AllenInstitute/vis/pull/14))
+
+* first pass at a system which cant leak cache content references (unlike my first attempt)
+
+* finish up some thoughts on how this cache should work. start in on some tests to make sure I'm not crazy. ditch jest because its terrible, try vitest for now - its way nicer but kinda hard to read the output for debugging
+
+* test some more edgy cases of this separate-but-related cache system
+
+* update apps to deal with recent changes in scatterbrain caching system
+
+* stream of consciousness documentation plus basic build&run instructions
+
+* kick out jest - re-write tests using async and vitest
+
+* think about warning of unsafe use via jsdoc...
+
+* forgot to update this demo
+
+* spellcheck
+
+* quick readme for scatterplots
+
+* more words
+
+* Update apps/omezarr-viewer/README.md
+
+Co-authored-by: Lane Sawyer <lane.sawyer@alleninstitute.org>
+
+- Update apps/omezarr-viewer/README.md
+
+Co-authored-by: Lane Sawyer <lane.sawyer@alleninstitute.org>
+
+- fix initial versa view. fix a missing closing-brace that would have made cache-eviction waste a lot of time for no reason
+
+- kick jest out of geometry tests too, switch to vitest, confirm all tests pass
+
+- remove my debug logging
+
+- remove isAbortError
+
+---
+
+Co-authored-by: Lane Sawyer <lane.sawyer@alleninstitute.org>
+
+- DZI viewer component ([#29](https://github.com/AllenInstitute/vis/pull/29))
+
+Co-authored-by: Lane Sawyer <lane.sawyer@alleninstitute.org>
+
+### ⚙️ Miscellaneous Tasks
+
+- Chore - move code around to make writing new "apps" less repetative ([#16](https://github.com/AllenInstitute/vis/pull/16))
+
+* move the furniture around - make it easier to share code between various "apps" - the scenario being that the code doesn't yet belong in published-packages, but might have common use in various demos. created a new spatial indexing sub-folder for the geometry package, and put our generic "quad"t tree in there (it can be a tree of any power-of-2 dimension)
+
+* thinking about layers
+
+* PR feedback, disable using the .parcel-cache when building
+
+- Formatting ([#26](https://github.com/AllenInstitute/vis/pull/26))
+- CI workflow [DT-5996] ([#25](https://github.com/AllenInstitute/vis/pull/25))
+- Remove only-allow so builds stop failing ([#47](https://github.com/AllenInstitute/vis/pull/47))
+- Version bumps for only-allow removal release ([#51](https://github.com/AllenInstitute/vis/pull/51))
+
+## [0.0.2] - 2024-04-02
+
+### 🐛 Bug Fixes
+
+- _(vis-geometry)_ Adds missing functionality from `bkp-client` ([#10](https://github.com/AllenInstitute/vis/pull/10))
+
+### 💼 Other
+
+- A quick demo of how one might render a scatterplot (using ABC-atlas data) ([#7](https://github.com/AllenInstitute/vis/pull/7))
+
+* draw a blue screen in our scatterplot demo
+
+* add fetcher and visibility interface
+
+* make a renderer real quick
+
+* use the renderer, make a more interesting shader, the data is suspiciously ugly
+
+* minor cleanup
+
+---
+
+Co-authored-by: Lane Sawyer <lane.sawyer@alleninstitute.org>
+
+- Bump version
+
+### ⚙️ Miscellaneous Tasks
+
+- Use Parcel to produce libraries ([#9](https://github.com/AllenInstitute/vis/pull/9))
+
+## [0.0.1] - 2024-02-13
+
+### 🚀 Features
+
+- Publishing documentation and config changes ([#3](https://github.com/AllenInstitute/vis/pull/3))
+
+### 💼 Other
+
+- Initial working commit of copy-pasted geometry lib
+- Super basic scatterbrain package
+- Confirming I can import stuff from our workspace packages with full ts support, beggining work on a barebones omezarr renderer
+- Working basic volumetric slice rendering. cleanup a bunch of oopsies in the tsconfigs.
+- Add a bunch of controls to the demo, remove experimental zarr loader libs, fix math in shader
+- Implement a resolution-aware dataset layer picker, and a relative camera which is surprisingly nice
+- Right side up data, in the correct aspect ratio
+- When initializing the repo, names were changed, this fact was not reflected in imports vs. workspace packages.
+- Turn on tsconfig verbatimmodulesyntax. delete super busted old demo.
+  add a base tsconfig for the others to extend - still a work in progress.
+- Merge pull request [#1](https://github.com/AllenInstitute/vis/pull/1) from AllenInstitute/noah/cleanup-mistakes-during-repo-init
+
+Noah/cleanup mistakes during repo init
+
+<!-- generated by git-cliff -->