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(deps): update dependency jsdoc-to-markdown to v9 #262

Merged
merged 1 commit into from
Sep 3, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Sep 2, 2024

This PR contains the following updates:

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

Release Notes

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

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 - "after 2pm on Monday" in timezone Europe/Zurich, Automerge - At any time (no schedule defined).

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

Rebasing: Whenever PR becomes conflicted, 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.

Copy link

github-actions bot commented Sep 2, 2024

This PR will trigger no release when merged.

Copy link

codecov bot commented Sep 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8dc24e4) to head (2f17885).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #262   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          302       302           
=========================================
  Hits           302       302           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tripodsan tripodsan merged commit 44f76a5 into main Sep 3, 2024
6 checks passed
@tripodsan tripodsan deleted the renovate-major-external-major branch September 3, 2024 08:19
Copy link

🎉 This PR is included in version 3.0.19 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant