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

Update dependency jsdoc-to-markdown to v9 #1475

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

balena-renovate[bot]
Copy link
Contributor

@balena-renovate balena-renovate bot commented Nov 12, 2024

This PR contains the following updates:

Package Type Update Change
jsdoc-to-markdown devDependencies major ^8.0.0 -> ^9.0.0

Release Notes

jsdoc2md/jsdoc-to-markdown (jsdoc-to-markdown)

v9.0.5

Compare Source

Non-breaking changes since v9.0.4

  • Fixed a regression where spaces in the jsdoc binary path caused jsdoc2md to fail. #​307

v9.0.4

Compare Source

Non-breaking change

  • Implemented a permanent fix for the critical util.isRegExp is not a function issue in Node v23, replacing the previous temporary workaround. #​306

v9.0.3

Compare Source

Non-breaking change

  • Temporary workaround fix for critical util.isRegExp is not a function issue in Node v23: #​306

v9.0.2

Compare Source

Non-breaking

  • Fixed a scenario where --EOL failed to correctly replace naked CR characters created by jsdoc. jsdoc2md/dmd#102

v9.0.1

Compare Source

v9.0.0

Compare Source

The default output has not changed. The minimum required Node version is still v12.17. The goals for this release were bug fixing and simplification. Feel free to comment in the release discussion or post an issue.

Breaking changes since v8.0.3

  • Removed .renderSync(), .getTemplateDataSync() and .getJsdocDataSync(). The jsdoc2md API is now async-only.
  • Previously, passing either option.files or option.source was mandatory. Now, it is either option.files, option.source or option.configure. https://github.com/jsdoc2md/jsdoc-api/issues/27

Non-breaking changes

Other improvements

  • Greatly optimised the dependency tree - upgraded all deps to their latest versions (removing deprecation warnings) and factored many old modules out of the project.

Upgrade notes

  • Update your code replacing any use of .renderSync(), .getTemplateDataSync() and .getJsdocDataSync() with their async equivalents.
    • To see an example of API usage, see here.

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot.

@balena-renovate balena-renovate bot added dependencies Pull requests that update a dependency file devDependencies major renovate labels Nov 12, 2024
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-jsdoc-to-markdown branch 3 times, most recently from a84eecc to 9ddbd36 Compare November 14, 2024 19:53
@myarmolinsky
Copy link
Member

Looks like we're not affected by the breaking changes. Tested and it LGTM

Update jsdoc-to-markdown from 8.0.3 to 9.0.5

Change-type: patch
@Page- Page- force-pushed the renovate/major-9-jsdoc-to-markdown branch from 9ddbd36 to 5fa1b9f Compare November 19, 2024 13:04
@myarmolinsky myarmolinsky merged commit 6a6cc6d into master Nov 19, 2024
53 checks passed
@myarmolinsky myarmolinsky deleted the renovate/major-9-jsdoc-to-markdown branch November 19, 2024 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file devDependencies major renovate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant