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 docusaurus-plugin-typedoc to v1 #4491

Merged
merged 2 commits into from
Jun 25, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented May 13, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
docusaurus-plugin-typedoc (source) 0.22.0 -> 1.0.1 age adoption passing confidence

Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.


Release Notes

typedoc2md/typedoc-plugin-markdown (docusaurus-plugin-typedoc)

v1.0.1

Compare Source

Patch Changes
  • Handle windows path separators when generating sidebar ids

v1.0.0

Compare Source

v1 is a major release that includes a number of improvements.

Architectural Changes
  • typedoc-plugin-markdown must be updated to V4.
  • category.yml files are no longer written.
  • Frontmatter is no longer included by default.
Breaking Changes
Sidebar Configuration
  • A manual sidebar file should be referenced in sidebars.js rather than autogenerated configuration as previously recommended.
Options Changes
  • includeExtension has been removed as this behaviour is now the default.
  • frontmatter option has been removed. Please use typedoc-plugin-frontmatter.
  • sidebar options position and categoryLabel are no longer relevant and have been removed.
Bug Fixes
  • Correctly handle sidebar ids in Windows (#​597).
  • Provide exit code on process error (#​583)
  • Use correct path separator in sidebar urls (#​489)
  • Fail docusaurus build when TypeDoc errors - can be overridden with skipErrorChecking (#​429).

Earlier changelog entries can be found in CHANGELOG_ARCHIVE.md.


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 has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot requested a review from a team as a code owner May 13, 2024 15:16
@renovate renovate bot added dependencies Pull requests that update a dependency file slack PRs and issues with this label will be pushed to Slack labels May 13, 2024
@renovate renovate bot force-pushed the renovate/docusaurus-plugin-typedoc-1.x branch 22 times, most recently from 7746901 to 8209d6f Compare May 19, 2024 21:04
@renovate renovate bot force-pushed the renovate/docusaurus-plugin-typedoc-1.x branch 5 times, most recently from f04a97b to 7785027 Compare May 21, 2024 13:36
@renovate renovate bot force-pushed the renovate/docusaurus-plugin-typedoc-1.x branch 8 times, most recently from 8948d16 to 3947cb0 Compare June 20, 2024 11:53
Copy link

There were failures in the visual tests workflow.
Image diffs for visual tests can be downloaded as an artifact here.

@renovate renovate bot force-pushed the renovate/docusaurus-plugin-typedoc-1.x branch 12 times, most recently from 97aab05 to ef6a9eb Compare June 25, 2024 09:01
@renovate renovate bot force-pushed the renovate/docusaurus-plugin-typedoc-1.x branch from ef6a9eb to 52ebb7e Compare June 25, 2024 09:10
@haakonflatval-cognite haakonflatval-cognite enabled auto-merge (squash) June 25, 2024 09:31
Currently it crashes, and I don't know how to fix this in a nice way
@pramodcog pramodcog removed the do-not-merge Don't merge this PR yet. label Jun 25, 2024
Copy link
Contributor

@pramodcog pramodcog left a comment

Choose a reason for hiding this comment

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

Docs example code snippet's are working, Nice!

@haakonflatval-cognite haakonflatval-cognite merged commit 4187203 into master Jun 25, 2024
14 checks passed
@haakonflatval-cognite haakonflatval-cognite deleted the renovate/docusaurus-plugin-typedoc-1.x branch June 25, 2024 11:00
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 preview-docs Deploy preview documentation for a PR slack PRs and issues with this label will be pushed to Slack
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants