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: remove tests from build-docs: improves speed, avoid failure in… #2663

Closed
wants to merge 1 commit into from

Conversation

ac10n
Copy link
Contributor

@ac10n ac10n commented Sep 20, 2023

Before this change:

If test code has build errors, npm run build would succeed (because it correctly excludes tests from build), but npm run build-docs fail, because it does not exclude test files. While it's good to know that a test file has build error, it is not related to building docs.

Also, building test files when building docs slows down the build. In my test, about 60% of npm run build-docs time can be avoided if we exclude test files.

Thank you for your contribution to Taquito.

Before submitting this PR, please make sure:

  • Your code builds cleanly without any errors or warnings
  • You have run the linter against the changes
  • You have added unit tests (if relevant/appropriate)
  • You have added integration tests (if relevant/appropriate)
  • All public methods or types have TypeDoc coverage with a complete description, and ideally an @example
  • You have added or updated corresponding documentation
  • If relevant, you have written a first draft summary describing the change for inclusion in Release Notes.

In this PR, please also make sure:

  • You have linked this PR to the issue by putting closes #TICKETNUMBER in the description box (when applicable)
  • You have added a concise description on your changes

Release Note Draft Snippet

If relevant, please write a summary of your change that will be suitable for
inclusion in the Release Notes for the next Taquito release.

@netlify
Copy link

netlify bot commented Sep 20, 2023

Deploy Preview for taquito-test-dapp ready!

Name Link
🔨 Latest commit b1ffeb9
🔍 Latest deploy log https://app.netlify.com/sites/taquito-test-dapp/deploys/650b71e1441820000890aa26
😎 Deploy Preview https://deploy-preview-2663--taquito-test-dapp.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ac10n ac10n requested a review from hui-an-yang September 20, 2023 22:27
@github-actions
Copy link

New packages have been deployed to the preview repository at https://npm.preview.tezostaquito.io/.

Published packages:

npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/

@github-actions
Copy link

A new deploy preview is available on Netlify at https://3b5932d--tezostaquito.netlify.app

@ac10n ac10n requested a review from dsawali October 4, 2023 18:32
@dsawali
Copy link
Contributor

dsawali commented Oct 6, 2023

I'm not sure about the implications of excluding the tests from here. npm run build-docs actually build the typedoc pages of these files.

@ac10n
Copy link
Contributor Author

ac10n commented Oct 6, 2023

I'm not sure about the implications of excluding the tests from here. npm run build-docs actually build the typedoc pages of these files.

IMHO if we do not have typedocs for tests, then building tests would be unnecessary?

@ac10n
Copy link
Contributor Author

ac10n commented Oct 12, 2023

One more interesting thing: removing these improves website build speed a lot

@ac10n
Copy link
Contributor Author

ac10n commented Oct 17, 2023

This can be closed in favor of #2693

@ac10n ac10n closed this Oct 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