Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(e2e): TypeCheck website/starter in min/max range of TS versions #10063

Merged
merged 3 commits into from
Apr 19, 2024
Merged

test(e2e): TypeCheck website/starter in min/max range of TS versions #10063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fec73cc
TypeCheck website/starter in min/max range of TS versions
slorber Apr 19, 2024
1a73a93
Fix e2e tests
slorber Apr 19, 2024
41253cf
Upgrade docs to require TS v5.1
slorber Apr 19, 2024
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
18 changes: 17 additions & 1 deletion .github/workflows/tests-e2e.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,27 @@ jobs:
working-directory: ../test-website
env:
E2E_TEST: true
- name: Type check

- name: TypeCheck website
# TODO: there're some lingering issues with PnP + tsc. Enable tsc in PnP later.
if: matrix.variant == '-st' && matrix.nodeLinker != 'pnp'
working-directory: ../test-website
run: yarn typecheck
- name: TypeCheck website - min version - v5.1
# TODO: there're some lingering issues with PnP + tsc. Enable tsc in PnP later.
if: matrix.variant == '-st' && matrix.nodeLinker != 'pnp'
working-directory: ../test-website
run: |
yarn add typescript@5.1.6 --exact
yarn typecheck
- name: TypeCheck website - max version - Latest
# TODO: there're some lingering issues with PnP + tsc. Enable tsc in PnP later.
if: matrix.variant == '-st' && matrix.nodeLinker != 'pnp'
working-directory: ../test-website
run: |
yarn add typescript@latest --exact
yarn typecheck

- name: Build test-website project
run: yarn build
working-directory: ../test-website
Expand Down
9 changes: 9 additions & 0 deletions .github/workflows/tests-windows.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,14 @@ jobs:
run: yarn workspace website test:swizzle:wrap:ts
- name: Docusaurus Build
run: yarn build:website:fast

- name: TypeCheck website
run: yarn workspace website typecheck
- name: TypeCheck website - min version - v5.1
run: |
yarn workspace website add typescript@5.1.6 --exact
yarn workspace website typecheck
- name: TypeCheck website - max version - Latest
run: |
yarn workspace website add typescript@latest --exact
yarn workspace website typecheck
13 changes: 11 additions & 2 deletions .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,18 @@ jobs:
run: yarn
- name: Test
run: yarn test
- name: TypeCheck website
run: yarn workspace website typecheck
- name: Remove Theme Internal Re-export
run: yarn workspace @docusaurus/theme-common removeThemeInternalReexport
- name: Docusaurus Build
run: yarn build:website:fast

- name: TypeCheck website
run: yarn workspace website typecheck
- name: TypeCheck website - min version - v5.1
run: |
yarn workspace website add typescript@5.1.6 --exact
yarn workspace website typecheck
- name: TypeCheck website - max version - Latest
run: |
yarn workspace website add typescript@latest --exact
yarn workspace website typecheck
8 changes: 4 additions & 4 deletions website/docs/migration/v3.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Docusaurus v3 now uses the following dependencies:
- Node.js v18.0+
- React v18.0+
- MDX v3.0+
- TypeScript v5.0+
- TypeScript v5.1+
- prism-react-renderer v2.0+
- react-live v4.0+
- remark-emoji v4.0+
Expand Down Expand Up @@ -98,7 +98,7 @@ For TypeScript users:
// upgrade React types to v18.0+
- "@types/react": "^17.0.69",
+ "@types/react": "^18.2.29",
// upgrade TypeScript to v5.0+
// upgrade TypeScript to v5.1+
- "typescript": "~4.7.4"
+ "typescript": "~5.2.2"
}
Expand Down Expand Up @@ -689,9 +689,9 @@ However, this is a new major library version containing breaking changes, and we

:::

### TypeScript v5.0+
### TypeScript v5.1+

Docusaurus v3 now requires **TypeScript >= 5.0**.
Docusaurus v3 now requires **TypeScript >= 5.1**.

:::info How to upgrade

Expand Down
2 changes: 1 addition & 1 deletion website/docs/typescript-support.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Docusaurus is written in TypeScript and provides first-class TypeSc

Docusaurus is written in TypeScript and provides first-class TypeScript support.

The minimum required version is **TypeScript 5.0**.
The minimum required version is **TypeScript 5.1**.

## Initialization {#initialization}

Expand Down
8 changes: 4 additions & 4 deletions website/versioned_docs/version-3.0.1/migration/v3.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Docusaurus v3 now uses the following dependencies:
- Node.js v18.0+
- React v18.0+
- MDX v3.0+
- TypeScript v5.0+
- TypeScript v5.1+
- prism-react-renderer v2.0+
- react-live v4.0+
- remark-emoji v4.0+
Expand Down Expand Up @@ -98,7 +98,7 @@ For TypeScript users:
// upgrade React types to v18.0+
- "@types/react": "^17.0.69",
+ "@types/react": "^18.2.29",
// upgrade TypeScript to v5.0+
// upgrade TypeScript to v5.1+
- "typescript": "~4.7.4"
+ "typescript": "~5.2.2"
}
Expand Down Expand Up @@ -601,9 +601,9 @@ However, this is a new major library version containing breaking changes, and we

:::

### TypeScript v5.0+
### TypeScript v5.1+

Docusaurus v3 now requires **TypeScript >= 5.0**.
Docusaurus v3 now requires **TypeScript >= 5.1**.

:::info How to upgrade

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-3.0.1/typescript-support.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Docusaurus is written in TypeScript and provides first-class TypeSc

Docusaurus is written in TypeScript and provides first-class TypeScript support.

The minimum required version is **TypeScript 5.0**.
The minimum required version is **TypeScript 5.1**.

## Initialization {#initialization}

Expand Down
8 changes: 4 additions & 4 deletions website/versioned_docs/version-3.1.1/migration/v3.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Docusaurus v3 now uses the following dependencies:
- Node.js v18.0+
- React v18.0+
- MDX v3.0+
- TypeScript v5.0+
- TypeScript v5.1+
- prism-react-renderer v2.0+
- react-live v4.0+
- remark-emoji v4.0+
Expand Down Expand Up @@ -98,7 +98,7 @@ For TypeScript users:
// upgrade React types to v18.0+
- "@types/react": "^17.0.69",
+ "@types/react": "^18.2.29",
// upgrade TypeScript to v5.0+
// upgrade TypeScript to v5.1+
- "typescript": "~4.7.4"
+ "typescript": "~5.2.2"
}
Expand Down Expand Up @@ -689,9 +689,9 @@ However, this is a new major library version containing breaking changes, and we

:::

### TypeScript v5.0+
### TypeScript v5.1+

Docusaurus v3 now requires **TypeScript >= 5.0**.
Docusaurus v3 now requires **TypeScript >= 5.1**.

:::info How to upgrade

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-3.1.1/typescript-support.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Docusaurus is written in TypeScript and provides first-class TypeSc

Docusaurus is written in TypeScript and provides first-class TypeScript support.

The minimum required version is **TypeScript 5.0**.
The minimum required version is **TypeScript 5.1**.

## Initialization {#initialization}

Expand Down
8 changes: 4 additions & 4 deletions website/versioned_docs/version-3.2.1/migration/v3.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Docusaurus v3 now uses the following dependencies:
- Node.js v18.0+
- React v18.0+
- MDX v3.0+
- TypeScript v5.0+
- TypeScript v5.1+
- prism-react-renderer v2.0+
- react-live v4.0+
- remark-emoji v4.0+
Expand Down Expand Up @@ -98,7 +98,7 @@ For TypeScript users:
// upgrade React types to v18.0+
- "@types/react": "^17.0.69",
+ "@types/react": "^18.2.29",
// upgrade TypeScript to v5.0+
// upgrade TypeScript to v5.1+
- "typescript": "~4.7.4"
+ "typescript": "~5.2.2"
}
Expand Down Expand Up @@ -689,9 +689,9 @@ However, this is a new major library version containing breaking changes, and we

:::

### TypeScript v5.0+
### TypeScript v5.1+

Docusaurus v3 now requires **TypeScript >= 5.0**.
Docusaurus v3 now requires **TypeScript >= 5.1**.

:::info How to upgrade

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-3.2.1/typescript-support.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Docusaurus is written in TypeScript and provides first-class TypeSc

Docusaurus is written in TypeScript and provides first-class TypeScript support.

The minimum required version is **TypeScript 5.0**.
The minimum required version is **TypeScript 5.1**.

## Initialization {#initialization}

Expand Down
Loading