Skip to content
This repository has been archived by the owner on Oct 17, 2024. It is now read-only.

chore(deps): update dependency jsdoc-to-markdown to v9 #386

Merged
merged 1 commit into from
Sep 10, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Sep 1, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
jsdoc-to-markdown 8.0.3 -> 9.0.1 age adoption passing confidence

Warning

Some dependencies could not be looked up. Check the warning logs for more information.


Release Notes

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

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 - "every weekend" (UTC), 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 was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the renovate label Sep 1, 2024
@renovate renovate bot requested review from a team as code owners September 1, 2024 16:04
@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from a9c9c7d to b008b5d Compare September 7, 2024 04:37
@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from b008b5d to f68f405 Compare September 8, 2024 13:56
Copy link
Collaborator

@cbt1 cbt1 left a comment

Choose a reason for hiding this comment

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

Approving as the spec generated are the same

@cbt1 cbt1 merged commit 83ccb64 into main Sep 10, 2024
16 checks passed
@cbt1 cbt1 deleted the renovate/jsdoc-to-markdown-9.x branch September 10, 2024 10:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant