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.

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

feat(clients): extend from root typedoc.client.json #3136

Merged
merged 4 commits into from
Jan 5, 2022

Conversation

trivikr
Copy link
Member

@trivikr trivikr commented Jan 5, 2022

Issue

Part of using root tsconfig for all clients in aws-sdk-js-v3
Refs: #1307

Description

Extends typedoc.json in clients from root typedoc.client.json

Testing

Verified that docs are generated correctly by running the following commands:

$ yarn build-documentation --clientDocs docs/clients/{{CLIENT}} --theme
$ ./node_modules/.bin/lerna exec --scope '@aws-sdk/client-*' --no-bail --stream -- node ./node_modules/.bin/typedoc --out $(pwd)/docs/clients/$(basename \$LERNA_PACKAGE_NAME) --theme

The link to the webserver of docs was shared with reviewer @AllanZhengYP internally:

  • main: http://[IP]:8000/clients/@aws-sdk/client-s3/index.html
  • PR branch: http://[IP]:8002/clients/@aws-sdk/client-s3/index.html

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@trivikr trivikr marked this pull request as ready for review January 5, 2022 01:04
@trivikr trivikr requested a review from a team as a code owner January 5, 2022 01:04
@trivikr trivikr changed the base branch from typedoc-json to main January 5, 2022 01:05
@trivikr trivikr changed the title feat(clients): extend from typedoc.client.json feat(clients): extend from root typedoc.client.json Jan 5, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #3136 (f130f9e) into main (b302f16) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3136   +/-   ##
=======================================
  Coverage   75.19%   75.19%           
=======================================
  Files         474      474           
  Lines       20721    20721           
  Branches     4755     4755           
=======================================
  Hits        15581    15581           
  Misses       5140     5140           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b302f16...f130f9e. Read the comment docs.

@trivikr trivikr merged commit f6a3ef5 into aws:main Jan 5, 2022
@trivikr trivikr deleted the root-typedoc-json branch January 5, 2022 03:04
@github-actions
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants