Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/autofix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5.0.1
uses: actions/checkout@v6.0.1
with:
fetch-depth: 0
- name: Setup Tools
uses: tanstack/config/.github/setup@main
- name: Fix formatting
run: pnpm format
- name: Regenerate docs
run: pnpm build && pnpm generate-docs
- name: Apply fixes
uses: autofix-ci/action@635ffb0c9798bd160680f18fd73371e355b85f27
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/claude.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
actions: read # Required for Claude to read CI results on PRs
steps:
- name: Checkout code
uses: actions/checkout@v4
uses: actions/checkout@v6.0.1
with:
fetch-depth: 0 # required for Claude Code
- uses: anthropics/claude-code-action@v1
Expand Down
104 changes: 0 additions & 104 deletions .github/workflows/docs-sync.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/e2e-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v4
uses: actions/checkout@v6.0.1

- name: Setup pnpm
uses: pnpm/action-setup@v4
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5.0.1
uses: actions/checkout@v6.0.1
with:
fetch-depth: 0
- name: Setup Tools
Expand All @@ -39,7 +39,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5.0.1
uses: actions/checkout@v6.0.1
with:
fetch-depth: 0
- name: Setup Tools
Expand Down Expand Up @@ -67,7 +67,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5.0.1
uses: actions/checkout@v6.0.1
- name: Setup Tools
uses: tanstack/config/.github/setup@main
- name: Build Packages
Expand All @@ -81,7 +81,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5.0.1
uses: actions/checkout@v6.0.1
- name: Setup Tools
uses: tanstack/config/.github/setup@main
- name: Build Packages
Expand Down
29 changes: 1 addition & 28 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5.0.1
uses: actions/checkout@v6.0.1
with:
fetch-depth: 0
- name: Setup Tools
Expand All @@ -40,33 +40,6 @@ jobs:
title: 'ci: Version Packages'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did you remove this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NPM tokens are going away as of 9th Dec - I've switched it to publish with trusted publishing

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant our doc publishing workflow

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs are generated during the autofix workflow now, in https://github.com/TanStack/ai/blob/main/.github/workflows/autofix.yml

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, that's what we started with too but it makes for an awful PR authoring experience as you're constantly running doc generation + the PRs are full of tiny changes. I already put a PR there to change that TanStack/ai#97

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah thats a good point, sounds like a better idea 👍

- name: Generate Docs
if: steps.changesets.outputs.published == 'true'
run: pnpm generate-docs
- name: Commit Generated Docs
if: steps.changesets.outputs.published == 'true'
run: |
if [ -n "$(git status --porcelain)" ]; then
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"

BRANCH="docs/auto-update-$(date +%s)"
git checkout -b "$BRANCH"
git add docs/
git commit -m "docs: regenerate API documentation"
git push origin "$BRANCH"

gh pr create \
--title "docs: regenerate API documentation" \
--body "Automated documentation update from release" \
--base main \
--head "$BRANCH"
else
echo "No changes in generated docs"
fi
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Comment on PRs about release
if: steps.changesets.outputs.published == 'true'
uses: tanstack/config/.github/comment-on-release@main
Expand Down
4 changes: 0 additions & 4 deletions .husky/pre-commit

This file was deleted.

2 changes: 1 addition & 1 deletion docs/framework/angular/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ npm install @tanstack/angular-db

See the [Angular Functions Reference](./reference/index.md) to see the full list of functions available in the Angular Adapter.

For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries).
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).

## Basic Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/framework/angular/reference/functions/injectLiveQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Defined in: [index.ts:74](https://github.com/TanStack/db/blob/main/packages/angu
function injectLiveQuery<TContext>(config): InjectLiveQueryResult<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
```

Defined in: [index.ts:77](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L77)
Defined in: [index.ts:79](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L79)

### Type Parameters

Expand All @@ -151,7 +151,7 @@ Defined in: [index.ts:77](https://github.com/TanStack/db/blob/main/packages/angu
function injectLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): InjectLiveQueryResult<TResult, TKey, TUtils>;
```

Defined in: [index.ts:80](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L80)
Defined in: [index.ts:82](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L82)

### Type Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/framework/angular/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ title: "@tanstack/angular-db"

## Interfaces

- [InjectLiveQueryResult](./interfaces/InjectLiveQueryResult.md)
- [InjectLiveQueryResult](interfaces/InjectLiveQueryResult.md)

## Functions

- [injectLiveQuery](./functions/injectLiveQuery.md)
- [injectLiveQuery](functions/injectLiveQuery.md)
2 changes: 1 addition & 1 deletion docs/framework/react/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ npm install @tanstack/react-db

See the [React Functions Reference](./reference/index.md) to see the full list of hooks available in the React Adapter.

For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries).
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).

## Basic Usage

Expand Down
14 changes: 7 additions & 7 deletions docs/framework/react/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ title: "@tanstack/react-db"

## Type Aliases

- [UseLiveInfiniteQueryConfig](./type-aliases/UseLiveInfiniteQueryConfig.md)
- [UseLiveInfiniteQueryReturn](./type-aliases/UseLiveInfiniteQueryReturn.md)
- [UseLiveQueryStatus](./type-aliases/UseLiveQueryStatus.md)
- [UseLiveInfiniteQueryConfig](type-aliases/UseLiveInfiniteQueryConfig.md)
- [UseLiveInfiniteQueryReturn](type-aliases/UseLiveInfiniteQueryReturn.md)
- [UseLiveQueryStatus](type-aliases/UseLiveQueryStatus.md)

## Functions

- [useLiveInfiniteQuery](./functions/useLiveInfiniteQuery.md)
- [useLiveQuery](./functions/useLiveQuery.md)
- [useLiveSuspenseQuery](./functions/useLiveSuspenseQuery.md)
- [usePacedMutations](./functions/usePacedMutations.md)
- [useLiveInfiniteQuery](functions/useLiveInfiniteQuery.md)
- [useLiveQuery](functions/useLiveQuery.md)
- [useLiveSuspenseQuery](functions/useLiveSuspenseQuery.md)
- [usePacedMutations](functions/usePacedMutations.md)
2 changes: 1 addition & 1 deletion docs/framework/solid/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ npm install @tanstack/solid-db

See the [Solid Functions Reference](./reference/index.md) to see the full list of primitives available in the Solid Adapter.

For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries).
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).

## Basic Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/framework/solid/reference/functions/useLiveQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ return (
function useLiveQuery<TContext>(config): object;
```

Defined in: [useLiveQuery.ts:158](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L158)
Defined in: [useLiveQuery.ts:160](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L160)

Create a live query using configuration object

Expand Down Expand Up @@ -423,7 +423,7 @@ return (
function useLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): object;
```

Defined in: [useLiveQuery.ts:208](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L208)
Defined in: [useLiveQuery.ts:210](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L210)

Subscribe to an existing live query collection

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/solid/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ title: "@tanstack/solid-db"

## Functions

- [useLiveQuery](./functions/useLiveQuery.md)
- [useLiveQuery](functions/useLiveQuery.md)
Loading
Loading