ci: upload docs when submitting pr

.github/workflows/pull-request-docs.yml

@@ -0,0 +1,27 @@
+name: Pull Request
+
+on:
+  pull_request:
+    paths:
+      - docs
+      - packages/*/src/**/*.ts
+    types: [opened, synchronize]
+
+concurrency:
+  cancel-in-progress: true
+  group: pr-docs-${{ github.head_ref }}
+
+jobs:
+  test:
+    name: Docs Artifact
+    runs-on: ubuntu-latest
+    if: github.actor != 'renovate[bot]' || github.actor != 'dependabot[bot]'
+    steps:
+      - name: Build Docs
+        run: yarn build:docs
+
+      - name: Upload Docs
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: docs

docs/extensions/sinks.md

@@ -25,6 +25,6 @@ You can combine a number of sink implmentations by using the [SinkComposite](/st
 
 ```typescript
 new WritableStream(
-  new SinkComposite([new ForkableRecallSink(), write(console.info)])
+  new SinkComposite([new ForkableRecallSink(), write(console.info)]),
 )
 ```

docs/extensions/sources.md

@@ -32,6 +32,6 @@ new ReadableStream(
   new SourceComposite([
     new ControllableStream(),
     { start: (controller) => controller.enqueue() },
-  ])
+  ]),
 )
 ```

packages/stream-assert/CHANGELOG.md

@@ -2,64 +2,56 @@
 
 ## [1.1.0](https://github.com/jg-wright/stream/compare/stream-assert-v1.0.2...stream-assert-v1.1.0) (2026-05-28)
 
-
 ### Features
 
-* add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac))
-
+- add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac))
 
 ### Dependencies
 
-* The following workspace dependencies were updated
-  * devDependencies
-    * @johngw/stream-test bumped from 2.0.1 to 2.1.0
-  * peerDependencies
-    * @johngw/stream-test bumped from ^2.0.1 to ^2.1.0
+- The following workspace dependencies were updated
+  - devDependencies
+    - @johngw/stream-test bumped from 2.0.1 to 2.1.0
+  - peerDependencies
+    - @johngw/stream-test bumped from ^2.0.1 to ^2.1.0
 
 ## [1.0.2](https://github.com/jg-wright/stream/compare/stream-assert-v1.0.1...stream-assert-v1.0.2) (2026-05-27)
 
-
 ### Bug Fixes
 
-* correct peer dependency ([9256934](https://github.com/jg-wright/stream/commit/92569340e51c17caa4c33215b773c49b1ee111ee))
+- correct peer dependency ([9256934](https://github.com/jg-wright/stream/commit/92569340e51c17caa4c33215b773c49b1ee111ee))
 
 ## [1.0.1](https://github.com/jg-wright/stream/compare/stream-assert-v1.0.0...stream-assert-v1.0.1) (2026-05-27)
 
-
 ### Bug Fixes
 
-* **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8))
-
+- **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8))
 
 ### Dependencies
 
-* The following workspace dependencies were updated
-  * devDependencies
-    * @johngw/stream-test bumped from 2.0.0 to 2.0.1
-  * peerDependencies
-    * @johngw/stream-test bumped from ^1.3.1 to ^2.0.1
+- The following workspace dependencies were updated
+  - devDependencies
+    - @johngw/stream-test bumped from 2.0.0 to 2.0.1
+  - peerDependencies
+    - @johngw/stream-test bumped from ^1.3.1 to ^2.0.1
 
 ## 1.0.0 (2026-05-27)
 
-
 ### ⚠ BREAKING CHANGES
 
-* Dropping bun support including stream-test-bun
+- Dropping bun support including stream-test-bun
 
 ### Features
 
-* add stream-assert library ([ad89d94](https://github.com/jg-wright/stream/commit/ad89d94a9a5bb973ca3ba7afe6e0ccab1f56e5d3))
-
+- add stream-assert library ([ad89d94](https://github.com/jg-wright/stream/commit/ad89d94a9a5bb973ca3ba7afe6e0ccab1f56e5d3))
 
 ### Miscellaneous Chores
 
-* move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8))
-
+- move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8))
 
 ### Dependencies
 
-* The following workspace dependencies were updated
-  * devDependencies
-    * @johngw/stream-test bumped from 1.3.1 to 2.0.0
-  * peerDependencies
-    * @johngw/stream-test bumped from ^1.3.1 to ^2.0.0
+- The following workspace dependencies were updated
+  - devDependencies
+    - @johngw/stream-test bumped from 1.3.1 to 2.0.0
+  - peerDependencies
+    - @johngw/stream-test bumped from ^1.3.1 to ^2.0.0

packages/stream-common/CHANGELOG.md

@@ -2,44 +2,39 @@
 
 ## [2.1.0](https://github.com/jg-wright/stream/compare/stream-common-v2.0.1...stream-common-v2.1.0) (2026-05-28)
 
-
 ### Features
 
-* add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac))
+- add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac))
 
 ## [2.0.1](https://github.com/jg-wright/stream/compare/stream-common-v2.0.0...stream-common-v2.0.1) (2026-05-27)
 
-
 ### Bug Fixes
 
-* **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8))
+- **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8))
 
 ## [2.0.0](https://github.com/jg-wright/stream/compare/stream-common-v1.1.2...stream-common-v2.0.0) (2026-05-27)
 
-
 ### ⚠ BREAKING CHANGES
 
-* Dropping bun support including stream-test-bun
+- Dropping bun support including stream-test-bun
 
 ### Features
 
-* add sink and source guards ([020cd61](https://github.com/jg-wright/stream/commit/020cd6151b706c3875b586f8c4b2b5abc5b0a7b7))
-* add type testing ([845200a](https://github.com/jg-wright/stream/commit/845200aca03ab11e7af060e98251c96662dc11e8))
-* mono repo ([18faac6](https://github.com/jg-wright/stream/commit/18faac6902eb30bb626b00fdf1d1e2185a14b757))
-* **subject:** multiple controllers ([c1bde5f](https://github.com/jg-wright/stream/commit/c1bde5f84e554d3b1c3a1c43d0a0075a7840863f))
-* **when:** curry ([8b1d57b](https://github.com/jg-wright/stream/commit/8b1d57b01fb4484af1e686a17bb94118458523bf))
-
+- add sink and source guards ([020cd61](https://github.com/jg-wright/stream/commit/020cd6151b706c3875b586f8c4b2b5abc5b0a7b7))
+- add type testing ([845200a](https://github.com/jg-wright/stream/commit/845200aca03ab11e7af060e98251c96662dc11e8))
+- mono repo ([18faac6](https://github.com/jg-wright/stream/commit/18faac6902eb30bb626b00fdf1d1e2185a14b757))
+- **subject:** multiple controllers ([c1bde5f](https://github.com/jg-wright/stream/commit/c1bde5f84e554d3b1c3a1c43d0a0075a7840863f))
+- **when:** curry ([8b1d57b](https://github.com/jg-wright/stream/commit/8b1d57b01fb4484af1e686a17bb94118458523bf))
 
 ### Bug Fixes
 
-* add .js import extensions ([d746712](https://github.com/jg-wright/stream/commit/d746712e028901c39dc2aee758b8aa38fea4a94d))
-* attempt to fix for commonjs modules ([0e11625](https://github.com/jg-wright/stream/commit/0e11625204ed1366579ae143e5adc1facb15415b))
-* attempt to fix for commonjs modules ([b335622](https://github.com/jg-wright/stream/commit/b3356229dedd75088982d39300239da3e7a5125f))
-* correct exporting for commonjs ([2d6b082](https://github.com/jg-wright/stream/commit/2d6b082af37e0c41a9b536d8cd914b7c8a9d5040))
-* default import should be common ([13ef94c](https://github.com/jg-wright/stream/commit/13ef94ccb7b9e8bebb1f825187e191c67ec5388d))
-* make sure to use import extensions ([5d38b4c](https://github.com/jg-wright/stream/commit/5d38b4c43817ee9531f4f7ed6c7693ba2026e4fa))
-
+- add .js import extensions ([d746712](https://github.com/jg-wright/stream/commit/d746712e028901c39dc2aee758b8aa38fea4a94d))
+- attempt to fix for commonjs modules ([0e11625](https://github.com/jg-wright/stream/commit/0e11625204ed1366579ae143e5adc1facb15415b))
+- attempt to fix for commonjs modules ([b335622](https://github.com/jg-wright/stream/commit/b3356229dedd75088982d39300239da3e7a5125f))
+- correct exporting for commonjs ([2d6b082](https://github.com/jg-wright/stream/commit/2d6b082af37e0c41a9b536d8cd914b7c8a9d5040))
+- default import should be common ([13ef94c](https://github.com/jg-wright/stream/commit/13ef94ccb7b9e8bebb1f825187e191c67ec5388d))
+- make sure to use import extensions ([5d38b4c](https://github.com/jg-wright/stream/commit/5d38b4c43817ee9531f4f7ed6c7693ba2026e4fa))
 
 ### Miscellaneous Chores
 
-* move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8))
+- move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8))

packages/stream-common/src/Test.ts

@@ -14,7 +14,7 @@ import type { Test } from 'ts-toolbelt'
  * ```
  */
 export function check<Type, Expect, Outcome extends B>(
-  _debug?: Type
+  _debug?: Type,
 ): Equals<Equals<Type, Expect>, Outcome> {
   return 1 as Equals<Equals<Type, Expect>, Outcome>
 }

packages/stream-jest/CHANGELOG.md

@@ -2,76 +2,67 @@
 
 ## [2.1.0](https://github.com/jg-wright/stream/compare/stream-jest-v2.0.2...stream-jest-v2.1.0) (2026-05-28)
 
-
 ### Features
 
-* add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac))
-
+- add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac))
 
 ### Dependencies
 
-* The following workspace dependencies were updated
-  * devDependencies
-    * @johngw/stream-test bumped from 2.0.1 to 2.1.0
-  * peerDependencies
-    * @johngw/stream-test bumped from ^2.0.1 to ^2.1.0
+- The following workspace dependencies were updated
+  - devDependencies
+    - @johngw/stream-test bumped from 2.0.1 to 2.1.0
+  - peerDependencies
+    - @johngw/stream-test bumped from ^2.0.1 to ^2.1.0
 
 ## [2.0.2](https://github.com/jg-wright/stream/compare/stream-jest-v2.0.1...stream-jest-v2.0.2) (2026-05-27)
 
-
 ### Bug Fixes
 
-* correct peer dependency ([9256934](https://github.com/jg-wright/stream/commit/92569340e51c17caa4c33215b773c49b1ee111ee))
+- correct peer dependency ([9256934](https://github.com/jg-wright/stream/commit/92569340e51c17caa4c33215b773c49b1ee111ee))
 
 ## [2.0.1](https://github.com/jg-wright/stream/compare/stream-jest-v2.0.0...stream-jest-v2.0.1) (2026-05-27)
 
-
 ### Bug Fixes
 
-* **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8))
-
+- **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8))
 
 ### Dependencies
 
-* The following workspace dependencies were updated
-  * devDependencies
-    * @johngw/stream-test bumped from 2.0.0 to 2.0.1
-  * peerDependencies
-    * @johngw/stream-test bumped from ^1.3.1 to ^2.0.1
+- The following workspace dependencies were updated
+  - devDependencies
+    - @johngw/stream-test bumped from 2.0.0 to 2.0.1
+  - peerDependencies
+    - @johngw/stream-test bumped from ^1.3.1 to ^2.0.1
 
 ## [2.0.0](https://github.com/jg-wright/stream/compare/stream-jest-v1.0.3...stream-jest-v2.0.0) (2026-05-27)
 
-
 ### ⚠ BREAKING CHANGES
 
-* Dropping bun support including stream-test-bun
+- Dropping bun support including stream-test-bun
 
 ### Features
 
-* display timeline position on error ([e39319e](https://github.com/jg-wright/stream/commit/e39319e1341b411a6865320f6697b21f37159fc2))
-* mono repo ([18faac6](https://github.com/jg-wright/stream/commit/18faac6902eb30bb626b00fdf1d1e2185a14b757))
-* **subject:** multiple controllers ([c1bde5f](https://github.com/jg-wright/stream/commit/c1bde5f84e554d3b1c3a1c43d0a0075a7840863f))
-
+- display timeline position on error ([e39319e](https://github.com/jg-wright/stream/commit/e39319e1341b411a6865320f6697b21f37159fc2))
+- mono repo ([18faac6](https://github.com/jg-wright/stream/commit/18faac6902eb30bb626b00fdf1d1e2185a14b757))
+- **subject:** multiple controllers ([c1bde5f](https://github.com/jg-wright/stream/commit/c1bde5f84e554d3b1c3a1c43d0a0075a7840863f))
 
 ### Bug Fixes
 
-* add .js import extensions ([d746712](https://github.com/jg-wright/stream/commit/d746712e028901c39dc2aee758b8aa38fea4a94d))
-* attempt to fix for commonjs modules ([0e11625](https://github.com/jg-wright/stream/commit/0e11625204ed1366579ae143e5adc1facb15415b))
-* attempt to fix for commonjs modules ([b335622](https://github.com/jg-wright/stream/commit/b3356229dedd75088982d39300239da3e7a5125f))
-* correct exporting for commonjs ([2d6b082](https://github.com/jg-wright/stream/commit/2d6b082af37e0c41a9b536d8cd914b7c8a9d5040))
-* correct test item type ([3cd17bd](https://github.com/jg-wright/stream/commit/3cd17bd472b31a06590c96b05f0ec50b3638ae14))
-* default import should be common ([13ef94c](https://github.com/jg-wright/stream/commit/13ef94ccb7b9e8bebb1f825187e191c67ec5388d))
-
+- add .js import extensions ([d746712](https://github.com/jg-wright/stream/commit/d746712e028901c39dc2aee758b8aa38fea4a94d))
+- attempt to fix for commonjs modules ([0e11625](https://github.com/jg-wright/stream/commit/0e11625204ed1366579ae143e5adc1facb15415b))
+- attempt to fix for commonjs modules ([b335622](https://github.com/jg-wright/stream/commit/b3356229dedd75088982d39300239da3e7a5125f))
+- correct exporting for commonjs ([2d6b082](https://github.com/jg-wright/stream/commit/2d6b082af37e0c41a9b536d8cd914b7c8a9d5040))
+- correct test item type ([3cd17bd](https://github.com/jg-wright/stream/commit/3cd17bd472b31a06590c96b05f0ec50b3638ae14))
+- default import should be common ([13ef94c](https://github.com/jg-wright/stream/commit/13ef94ccb7b9e8bebb1f825187e191c67ec5388d))
 
 ### Miscellaneous Chores
 
-* move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8))
-
+- move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8))
 
 ### Dependencies
 
-* The following workspace dependencies were updated
-  * devDependencies
-    * @johngw/stream-test bumped from 1.3.1 to 2.0.0
-  * peerDependencies
-    * @johngw/stream-test bumped from ^1.3.1 to ^2.0.0
+- The following workspace dependencies were updated
+  - devDependencies
+    - @johngw/stream-test bumped from 1.3.1 to 2.0.0
+  - peerDependencies
+    - @johngw/stream-test bumped from ^1.3.1 to ^2.0.0