Skip to content

chore(clients): do not clean docs during build #3140

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

Merged
merged 1 commit into from
Jan 5, 2022

Conversation

trivikr
Copy link
Member

@trivikr trivikr commented Jan 5, 2022

Issue

Refs: smithy-lang/smithy-typescript#485

Description

The build:docs command now calls typedoc directly, so that it can be used in internal release automation.

Testing

Verified that docs are generated with build:docs command in client-acm after manually removing typedoc binary

$ client-acm> rm -rf docs

$ client-acm> ls docs
ls: cannot access docs: No such file or directory

$ client-acm> ./node_modules/.bin/typedoc --version
zsh: no such file or directory: ./node_modules/.bin/typedoc

$ client-acm> yarn build:docs
yarn run v1.22.17
$ typedoc
Loaded plugin @aws-sdk/service-client-documentation-generator

Using TypeScript 4.3.5 from /local/home/trivikr/workspace/backup/backup-aws-sdk-js-v3/node_modules/typescript/lib
Warning: You are running in an unsupported TypeScript version! TypeDoc supports 3.9.x || 4.0.x
Deprecated as of 10.7.0. highlight(lang, code, ...args) has been deprecated.
Deprecated as of 10.7.0. Please use highlight(code, options) instead.
https://github.com/highlightjs/highlight.js/issues/2277
Rendering [========================================] 100%

Documentation generated at /local/home/trivikr/workspace/backup/backup-aws-sdk-js-v3/clients/client-acm/docs

Done in 7.74s.

$ client-acm> ls docs
assets  classes  enums  globals.html  index.html  interfaces  modules 

Verified that global 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 -- yarn build:docs --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]:8001/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 requested a review from a team as a code owner January 5, 2022 16:28
@trivikr trivikr merged commit e6ff930 into aws:main Jan 5, 2022
@trivikr trivikr deleted the no-clean-docs-before-build branch January 5, 2022 19:43
@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

2 participants