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 #83

Merged
merged 1 commit into from
Sep 3, 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.1 -> ^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 - 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 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
Contributor

github-actions bot commented Sep 1, 2024

🦙 MegaLinter status: ⚠️ WARNING

Descriptor Linter Files Fixed Errors Elapsed time
⚠️ ACTION actionlint 4 2 0.05s
✅ COPYPASTE jscpd yes no 1.33s
✅ JAVASCRIPT eslint 3 0 0 0.87s
✅ JAVASCRIPT prettier 3 0 0 0.61s
✅ JSON jsonlint 10 0 0.19s
✅ JSON npm-package-json-lint yes no 0.52s
✅ JSON prettier 10 0 0 0.56s
✅ JSON v8r 10 0 24.68s
✅ MARKDOWN markdownlint 2 0 0 0.53s
⚠️ MARKDOWN markdown-link-check 3 2 5.18s
✅ MARKDOWN markdown-table-formatter 3 0 0 0.26s
✅ REPOSITORY checkov yes no 13.48s
✅ REPOSITORY gitleaks yes no 0.41s
✅ REPOSITORY git_diff yes no 0.01s
✅ REPOSITORY grype yes no 13.82s
✅ REPOSITORY secretlint yes no 0.62s
✅ REPOSITORY trivy yes no 7.12s
✅ REPOSITORY trivy-sbom yes no 0.99s
✅ REPOSITORY trufflehog yes no 3.04s
✅ SPELL cspell 33 0 2.59s
✅ SPELL lychee 22 0 1.03s
✅ XML xmllint 5 0 0 0.01s
✅ YAML prettier 9 0 0 0.64s
✅ YAML v8r 8 0 8.78s
✅ YAML yamllint 9 0 0.31s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from 08f5764 to e74c943 Compare September 3, 2024 04:58
@nvuillam nvuillam merged commit 31b2169 into main Sep 3, 2024
6 checks passed
@renovate renovate bot deleted the renovate/jsdoc-to-markdown-9.x branch September 3, 2024 06:12
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.

1 participant