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

Fix typedoc prepare script to use npm #112

Merged
merged 2 commits into from Jun 9, 2021
Merged

Fix typedoc prepare script to use npm #112

merged 2 commits into from Jun 9, 2021

Conversation

refi93
Copy link
Collaborator

@refi93 refi93 commented Jun 8, 2021

Reason: typedoc has package.lock, and yarn install (what was being previously used) would not install locked
dependencies but the newest ones, hence breaking on newer packages than the ones that actually work being pulled

Further context: we are using a custom fork of typedoc which doesn't sort the properties, which gets downloaded and built within our repo: ppershing/typedoc@f32157c

I noticed the installation of the dependencies within the typedoc build step results in vulnerabilities being reported but these dependencies don't interfere with the dependencies of our package and is ran as a separate script to build the docs

Additionaly, yarn audit on ledgerjs repo itself was failing with glob-parent dependency so I fixed that as well

Reason: typedoc has package.lock, and yarn install would not install locked
dependencies but the newest one, hence breaking on newer packages than
the ones that actually work being pulled
Copy link
Collaborator

@gabrielKerekes gabrielKerekes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧙

@refi93
Copy link
Collaborator Author

refi93 commented Jun 9, 2021

Note: hopefully, the original reason why we forked typedoc will be addressed in the upcoming 0.21 version: TypeStrong/typedoc#112 (comment)

@refi93 refi93 merged commit 15518ad into develop Jun 9, 2021
@janmazak janmazak deleted the fix-typedoc-ci branch September 2, 2021 09:33
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.

None yet

2 participants