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

Updating typedoc check script #14702

Merged
merged 4 commits into from
Jan 12, 2024
Merged

Conversation

RaananW
Copy link
Member

@RaananW RaananW commented Jan 12, 2024

This changes slightly the script to check missing docs

  • It returns a sierialized object that holds all of the needed information to generate an error message
  • it returns an error code (1) if failed
  • it checks dev files, and allows checking only changed files (based on git's changed files)
  • It checks all of the packages in dev
  • it is possible to run a full check using --full
  • adding typedoc as dependency to be sure it is running correctly

@bjsplat
Copy link
Collaborator

bjsplat commented Jan 12, 2024

Please make sure to label your PR with "bug", "new feature" or "breaking change" label(s).
To prevent this PR from going to the changelog marked it with the "skip changelog" label.

@bjsplat
Copy link
Collaborator

bjsplat commented Jan 12, 2024

Reviewer - this PR has made changes to one or more package.json files.

@bjsplat
Copy link
Collaborator

bjsplat commented Jan 12, 2024

@RaananW RaananW merged commit 614b1db into BabylonJS:master Jan 12, 2024
10 checks passed
@RaananW RaananW deleted the prepareForTypedocChecks branch January 12, 2024 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants