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

chore: do not clean docs during build #485

Merged
merged 1 commit into from
Jan 5, 2022

Conversation

trivikr
Copy link
Contributor

@trivikr trivikr commented Jan 5, 2022

Issue #, if available:
Refs: aws/aws-sdk-js-v3#3138 (comment)

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

Reasons for removing clean:docs call:

  • The build:docs command should do work only what it's asked to do. Cleaning docs is an additional work.
  • The docs may not have been generated in the default docs folder. We'll decide later if clean:docs script should be removed altogether.
  • The typedoc dependency is being moved to root package.json in chore(scripts): remove devDeps defined in monorepo root aws/aws-sdk-js-v3#3138, so typedoc will not be available in node_modules for each client and they need to use build:docs command.

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 merged commit a924a83 into smithy-lang:main Jan 5, 2022
@trivikr trivikr deleted the no-clean-docs-before-build branch January 5, 2022 19:43
srchase pushed a commit to srchase/smithy-typescript that referenced this pull request Mar 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants