Skip to content

chore(deps-dev): bump typedoc to v0.23.23 #4458

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

Closed
wants to merge 32 commits into from
Closed

chore(deps-dev): bump typedoc to v0.23.23 #4458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
3358a12
feat: add core theme documentation generator
eduardomourar Nov 2, 2022
a7006c6
feat: update core packages documentation generator
eduardomourar Nov 2, 2022
6482e9f
feat: update service client documentation generator
eduardomourar Nov 2, 2022
eda7f87
chore: update typedoc to v0.23.11
eduardomourar Nov 2, 2022
5b7a913
chore: setup typedoc monorepo
eduardomourar Nov 2, 2022
eb992bb
chore: add readme file to typedoc config
eduardomourar Nov 2, 2022
76cc6b5
chore: allow typedoc plugin even without sources
eduardomourar Nov 2, 2022
cb102a6
chore: allow typedoc theme even without default group options
eduardomourar Nov 2, 2022
df80958
chore(performance workaround): update build:docs and core-documentati…
MYoung25 Dec 22, 2022
a68086d
chore(merge): merge main
MYoung25 Dec 22, 2022
48ef7e3
chore(fix-typedoc): fix typedoc issues with merging main
MYoung25 Dec 27, 2022
4267722
chore(add-cleanup): add automated cleanup of artifacts on build:docs
MYoung25 Dec 28, 2022
eeeba35
chore(merge): merge main
MYoung25 Dec 28, 2022
910dc87
chore(typedoc-a11y-plugin): add custom a11y plugin for TypeDoc
MYoung25 Feb 7, 2023
a960393
fix(update-client-theme): update links in client to make navigation s…
MYoung25 Feb 13, 2023
6c5ac91
chore(remove-rename): remove references to legacy plugin options
MYoung25 Feb 13, 2023
4e2df3a
docs(search-a11y): add keyboard navigation support for voiceover to s…
MYoung25 Feb 13, 2023
fc920d7
fix(include-packages): include packages in typedoc build
MYoung25 Feb 13, 2023
005fa41
chore(merge-main): merge and fix ts issues in main
MYoung25 Feb 14, 2023
7992123
chore(fix-merge-issues): update new packages TypeDoc information
MYoung25 Feb 15, 2023
e4094e7
Merge pull request #1 from MYoung25/chore/bump-typedoc-v0.23.23
MYoung25 Feb 16, 2023
202c2bc
chore(remove-duplicates): remove duplicate type declarations
MYoung25 Feb 16, 2023
b9919ce
chore(merge-main): merge aws-sdk-js-v3/main
MYoung25 Feb 16, 2023
9f20eb8
chore(fix-merge): fix merge artifacts
MYoung25 Feb 17, 2023
22b5ba5
chore(update-ts-loader): update ts-loader to fix failing tests
MYoung25 Feb 20, 2023
3ecbda7
chore(merge-main): merge main into bump-typedoc
MYoung25 Feb 21, 2023
e2c1040
Merge branch 'main' into chore/bump-typedoc-v0.23.23
MYoung25 Feb 21, 2023
55d257e
chore(undo-merge-formatting): undo formatting from merge commits
MYoung25 Feb 22, 2023
5c446b9
Merge branch 'main' into chore/bump-typedoc-v0.23.23
MYoung25 Feb 22, 2023
c4096a7
chore(typedoc-tnb): implement typedoc changes in tnb client
MYoung25 Feb 22, 2023
a7c03be
chore(remove-format): remove model formatting from git merges
MYoung25 Feb 22, 2023
db01d0b
chore(remove-format): remove model formatting from git merges
MYoung25 Feb 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 5 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,8 @@ codegen/*/.classpath
codegen/*/.settings/
codegen/*/bin

benchmark/size/raw
benchmark/size/raw

docs/
clientDocs/
**/docs/
27 changes: 14 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,27 +511,28 @@ For a full middleware stack deep dive please check out our [blog post](https://a

## Release Cadence

Our releases usually happen once per weekday. Each release increments the
Our releases usually happen once per weekday. Each release increments the
minor version, e.g. 3.200.0 -> 3.201.0.

## Stability of Modular Packages

|Package name|containing folder|API controlled by|stability|
|---|---|---|---|
|@aws-sdk/client-* Commands|clients|AWS service teams|public/stable|
|@aws-sdk/client-* Clients|clients|AWS SDK JS team|public/stable|
|@aws-sdk/lib-*|lib|AWS SDK JS team|public/stable|
|@aws-sdk/*-signer|packages|AWS SDK JS team|public/stable|
|@aws-sdk/middleware-stack|packages|AWS SDK JS team|public/stable|
|remaining @aws-sdk/*|packages|AWS SDK JS team|internal|
| Package name | containing folder | API controlled by | stability |
| --------------------------- | ----------------- | ----------------- | ------------- |
| @aws-sdk/client-\* Commands | clients | AWS service teams | public/stable |
| @aws-sdk/client-\* Clients | clients | AWS SDK JS team | public/stable |
| @aws-sdk/lib-\* | lib | AWS SDK JS team | public/stable |
| @aws-sdk/\*-signer | packages | AWS SDK JS team | public/stable |
| @aws-sdk/middleware-stack | packages | AWS SDK JS team | public/stable |
| remaining @aws-sdk/\* | packages | AWS SDK JS team | internal |

Additional notes:

- internal does not mean a package or interface is constantly changing
or being actively worked on. It means it is subject to change without any
notice period. The changes are included in the release notes.
or being actively worked on. It means it is subject to change without any
notice period. The changes are included in the release notes.
- public interfaces such as client configuration are also subject to change
in exceptional cases. We will try to undergo a deprecation period with
an advance notice.
in exceptional cases. We will try to undergo a deprecation period with
an advance notice.

## Known Issues

Expand Down
8 changes: 6 additions & 2 deletions clients/client-accessanalyzer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typescript": "~4.6.2"
"typedoc": "^0.23.23",
"typescript": "4.7.3"
Copy link
Member

Choose a reason for hiding this comment

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

Can we bump typeScript in a different PR?

},
"overrides": {
"typedoc": {
Expand Down Expand Up @@ -95,6 +95,10 @@
"react-native": {
"./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
},
"typedoc": {
Copy link
Member

Choose a reason for hiding this comment

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

The entrypoint and readmeFile is defined in typedoc.json

Is this config in package.json redundnant?

Copy link
Contributor

Choose a reason for hiding this comment

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

this here is actually needed for the client SDK itself because they are generated in isolation and not in the context of the Yarn workspaces

"entryPoint": "src/index.ts",
"readmeFile": "README.md"
},
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-accessanalyzer",
"repository": {
"type": "git",
Expand Down
5 changes: 4 additions & 1 deletion clients/client-accessanalyzer/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
8 changes: 6 additions & 2 deletions clients/client-account/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typescript": "~4.6.2"
"typedoc": "^0.23.23",
"typescript": "4.7.3"
},
"overrides": {
"typedoc": {
Expand Down Expand Up @@ -93,6 +93,10 @@
"react-native": {
"./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
},
"typedoc": {
"entryPoint": "src/index.ts",
"readmeFile": "README.md"
},
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-account",
"repository": {
"type": "git",
Expand Down
5 changes: 4 additions & 1 deletion clients/client-account/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
8 changes: 6 additions & 2 deletions clients/client-acm-pca/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typescript": "~4.6.2"
"typedoc": "^0.23.23",
"typescript": "4.7.3"
},
"overrides": {
"typedoc": {
Expand Down Expand Up @@ -94,6 +94,10 @@
"react-native": {
"./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
},
"typedoc": {
"entryPoint": "src/index.ts",
"readmeFile": "README.md"
},
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-acm-pca",
"repository": {
"type": "git",
Expand Down
5 changes: 4 additions & 1 deletion clients/client-acm-pca/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
8 changes: 6 additions & 2 deletions clients/client-acm/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typescript": "~4.6.2"
"typedoc": "^0.23.23",
"typescript": "4.7.3"
},
"overrides": {
"typedoc": {
Expand Down Expand Up @@ -94,6 +94,10 @@
"react-native": {
"./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
},
"typedoc": {
"entryPoint": "src/index.ts",
"readmeFile": "README.md"
},
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-acm",
"repository": {
"type": "git",
Expand Down
5 changes: 4 additions & 1 deletion clients/client-acm/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
8 changes: 6 additions & 2 deletions clients/client-alexa-for-business/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typescript": "~4.6.2"
"typedoc": "^0.23.23",
"typescript": "4.7.3"
},
"overrides": {
"typedoc": {
Expand Down Expand Up @@ -95,6 +95,10 @@
"react-native": {
"./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
},
"typedoc": {
"entryPoint": "src/index.ts",
"readmeFile": "README.md"
},
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-alexa-for-business",
"repository": {
"type": "git",
Expand Down
5 changes: 4 additions & 1 deletion clients/client-alexa-for-business/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
8 changes: 6 additions & 2 deletions clients/client-amp/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typescript": "~4.6.2"
"typedoc": "^0.23.23",
"typescript": "4.7.3"
},
"overrides": {
"typedoc": {
Expand Down Expand Up @@ -96,6 +96,10 @@
"react-native": {
"./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
},
"typedoc": {
"entryPoint": "src/index.ts",
"readmeFile": "README.md"
},
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-amp",
"repository": {
"type": "git",
Expand Down
5 changes: 4 additions & 1 deletion clients/client-amp/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
8 changes: 6 additions & 2 deletions clients/client-amplify/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typescript": "~4.6.2"
"typedoc": "^0.23.23",
"typescript": "4.7.3"
},
"overrides": {
"typedoc": {
Expand Down Expand Up @@ -93,6 +93,10 @@
"react-native": {
"./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
},
"typedoc": {
"entryPoint": "src/index.ts",
"readmeFile": "README.md"
},
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-amplify",
"repository": {
"type": "git",
Expand Down
5 changes: 4 additions & 1 deletion clients/client-amplify/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
8 changes: 6 additions & 2 deletions clients/client-amplifybackend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typescript": "~4.6.2"
"typedoc": "^0.23.23",
"typescript": "4.7.3"
},
"overrides": {
"typedoc": {
Expand Down Expand Up @@ -93,6 +93,10 @@
"react-native": {
"./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
},
"typedoc": {
"entryPoint": "src/index.ts",
"readmeFile": "README.md"
},
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-amplifybackend",
"repository": {
"type": "git",
Expand Down
5 changes: 4 additions & 1 deletion clients/client-amplifybackend/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
8 changes: 6 additions & 2 deletions clients/client-amplifyuibuilder/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typescript": "~4.6.2"
"typedoc": "^0.23.23",
"typescript": "4.7.3"
},
"overrides": {
"typedoc": {
Expand Down Expand Up @@ -95,6 +95,10 @@
"react-native": {
"./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
},
"typedoc": {
"entryPoint": "src/index.ts",
"readmeFile": "README.md"
},
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-amplifyuibuilder",
"repository": {
"type": "git",
Expand Down
5 changes: 4 additions & 1 deletion clients/client-amplifyuibuilder/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
8 changes: 6 additions & 2 deletions clients/client-api-gateway/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typescript": "~4.6.2"
"typedoc": "^0.23.23",
"typescript": "4.7.3"
},
"overrides": {
"typedoc": {
Expand Down Expand Up @@ -94,6 +94,10 @@
"react-native": {
"./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
},
"typedoc": {
"entryPoint": "src/index.ts",
"readmeFile": "README.md"
},
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-api-gateway",
"repository": {
"type": "git",
Expand Down
5 changes: 4 additions & 1 deletion clients/client-api-gateway/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
8 changes: 6 additions & 2 deletions clients/client-apigatewaymanagementapi/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typescript": "~4.6.2"
"typedoc": "^0.23.23",
"typescript": "4.7.3"
},
"overrides": {
"typedoc": {
Expand Down Expand Up @@ -93,6 +93,10 @@
"react-native": {
"./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
},
"typedoc": {
"entryPoint": "src/index.ts",
"readmeFile": "README.md"
},
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-apigatewaymanagementapi",
"repository": {
"type": "git",
Expand Down
5 changes: 4 additions & 1 deletion clients/client-apigatewaymanagementapi/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
Loading