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

build: allow breaking change when updating typedoc for documentation builds #2122

Merged
merged 2 commits into from
Dec 13, 2024

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Dec 13, 2024

Summary

This PR fixes the breaking builds found in #2108 and #2121 by allowing breaking changes to the typedoc package of docs 📚

Notes

I'm hoping @dependabot can help with the actual update to 0.27.x needed for these breaking builds, but this PR unlocks the update between 0.26.x and 0.27.x 🙏

Requirements

Sorry, something went wrong.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@zimeg zimeg added docs M-T: Documentation work only semver:patch dependencies Pull requests that update a dependency file labels Dec 13, 2024
@zimeg zimeg requested review from lukegalbraithrussell and a team December 13, 2024 23:37
@zimeg zimeg self-assigned this Dec 13, 2024
Copy link
Contributor

@lukegalbraithrussell lukegalbraithrussell left a comment

Choose a reason for hiding this comment

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

i haven't figured out a long term solution for this yet -- but we'll be moving away from the typedoc docusaurus plugin long term when i get a chance to build a little reference script

@zimeg
Copy link
Member Author

zimeg commented Dec 13, 2024

@lukegalbraithrussell Thanks for the fast review and insights into typedoc worlds! I'm excited for the reference script, but will keep chugging along with quick fixes in the meantime 😉

@zimeg zimeg merged commit 0c89dc6 into main Dec 13, 2024
57 checks passed
@zimeg zimeg deleted the zimeg-chore-dependabot-group-typedoc branch December 13, 2024 23:44
Copy link

codecov bot commented Dec 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.89%. Comparing base (3e5e4c6) to head (bd07008).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2122   +/-   ##
=======================================
  Coverage   91.89%   91.89%           
=======================================
  Files          38       38           
  Lines       10320    10320           
  Branches      649      649           
=======================================
  Hits         9484     9484           
  Misses        824      824           
  Partials       12       12           
Flag Coverage Δ
cli-hooks 95.24% <ø> (ø)
cli-test 94.48% <ø> (ø)
oauth 77.39% <ø> (ø)
socket-mode 61.82% <ø> (ø)
web-api 96.88% <ø> (ø)
webhook 96.65% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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 docs M-T: Documentation work only semver:patch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants