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: bump typedoc-plugin-markdown version to 4.2.2 #2650

Conversation

aditya172926
Copy link
Contributor

@aditya172926 aditya172926 commented Jun 30, 2024

Summary

  • Updated typedoc-plugin-markdown version to the latest version 4.2.2.
  • Also bumped up the versions of the dev dependencies typedoc & typedoc-plugin-merge-modules to 0.26.3 & 6.0.0 respectively for compatibility with typedoc-plugin-markdown.
  • Made edits in typedoc-postbuild.ts for building docs successfully due to changes introduced in merging modules structure by the latest version packages of typedoc-plugin-markdown.

Checklist

  • I addedtests to prove my changes
  • I updated — all the necessary docs
  • I reviewed — the entire PR myself, using the GitHub UI
  • I described — all breaking changes and the Migration Guide

@CLAassistant
Copy link

CLAassistant commented Jun 30, 2024

CLA assistant check
All committers have signed the CLA.

@petertonysmith94
Copy link
Contributor

You may want to add the following issue as closed to your PR :)

@aditya172926
Copy link
Contributor Author

You may want to add the following issue as closed to your PR :)

updated description to add this issue #2713 as well.

@petertonysmith94
Copy link
Contributor

Whenever you get the chance, could you update the description with the new PR template which can be found here.

Thanks @aditya172926!

@maschad
Copy link
Member

maschad commented Jul 22, 2024

Hey @aditya172926 thanks for taking this on, could you comment on #2713 so that we can assign that issue to you? Thanks.

@aditya172926
Copy link
Contributor Author

Hey @aditya172926 thanks for taking this on, could you comment on #2713 so that we can assign that issue to you? Thanks.

Done.

@aditya172926 aditya172926 changed the title chore: bump typedoc-plugin-markdown version to 4.1.0 chore: bump typedoc-plugin-markdown version to 4.2.2 Jul 27, 2024
@aditya172926 aditya172926 marked this pull request as ready for review July 27, 2024 21:21
Copy link
Contributor

@danielbate danielbate left a comment

Choose a reason for hiding this comment

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

@FuelLabs/sdk-ts anyone know why the vercel deploy isn't working? Ideally we'll also test this against the docs hub as the directory structure was intended to work there. Any changes in the dir structure to the generated API docs could break the docs hub.

@aditya172926
Copy link
Contributor Author

@FuelLabs/sdk-ts anyone know why the vercel deploy isn't working? Ideally we'll also test this against the docs hub as the directory structure was intended to work there. Any changes in the dir structure to the generated API docs could break the docs hub.

Looks like an authorization for fork deployment is required by a member of fuel labs team on vercel.

image

@danielbate
Copy link
Contributor

@aditya172926 I have authorised it but doesn't seem to be working. Bare with me.

@petertonysmith94
Copy link
Contributor

petertonysmith94 commented Jul 30, 2024

@aditya172926 Nicely done ❤️

I've approved the deployment, would you mind resolving the conflicts?

Not entirely sure why the checks are not being run though 🤔

@aditya172926
Copy link
Contributor Author

@aditya172926 Nicely done ❤️

I've approved the deployment, would you mind resolving the conflicts?

Not entirely sure why the checks are not being run though 🤔

Conflicts resolved

@aditya172926
Copy link
Contributor Author

@petertonysmith94 I have updated the branch to master. Could you approve workflows to see if they were successful? Some workflows and vercel build failed while executing CI setup in the previous commit.

@petertonysmith94
Copy link
Contributor

@petertonysmith94 I have updated the branch to master. Could you approve workflows to see if they were successful? Some workflows and vercel build failed while executing CI setup in the previous commit.

Ran the workflows - we will need to test these against the docs-hub to ensure nothing has broken. I'll have time to do this tomorrow for you :)

Copy link
Contributor

@petertonysmith94 petertonysmith94 left a comment

Choose a reason for hiding this comment

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

Built this out locally with the docs-hub and all looks good to me.

Nice one @aditya172926 🥇 ❤️

@aditya172926
Copy link
Contributor Author

Ready from my side. @maschad

@petertonysmith94 petertonysmith94 force-pushed the aditya172926/chore/typedoc-plugin-markdown branch from d2a2270 to 0737706 Compare August 26, 2024 08:43
@petertonysmith94
Copy link
Contributor

@aditya172926 I saw a lot of merged changeset within the PR and have pushed up a change to resolve this.

Please could you confirm everything looks good from your end, I'll retest the changes in the docs-hub now :)

@aditya172926
Copy link
Contributor Author

@aditya172926 I saw a lot of merged changeset within the PR and have pushed up a change to resolve this.

Please could you confirm everything looks good from your end, I'll retest the changes in the docs-hub now :)

I pushed a fix and a small change in the typedoc.json.
Rest of it looks good to me.

@petertonysmith94 petertonysmith94 force-pushed the aditya172926/chore/typedoc-plugin-markdown branch from 583f9e2 to 33753cf Compare August 26, 2024 10:33
Copy link
Contributor

@petertonysmith94 petertonysmith94 left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution @aditya172926 - and your patience 🙏🏼

Reviewed this on the docs hub and all looks good 🚢 .

Found the following issue, however, this is pre-existing.

@aditya172926
Copy link
Contributor Author

Thank you for your contribution @aditya172926 - and your patience 🙏🏼

Reviewed this on the docs hub and all looks good 🚢 .

Found the following issue, however, this is pre-existing.

Thanks to all the help I received from the reviewers 😊

maschad
maschad previously approved these changes Aug 26, 2024
…itya172926/chore/typedoc-plugin-markdown
@petertonysmith94 petertonysmith94 dismissed stale reviews from maschad and themself via 4b7ff9b August 27, 2024 17:36
Copy link

vercel bot commented Aug 27, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
create-fuels-counter-example ⬜️ Ignored (Inspect) Aug 27, 2024 5:36pm
create-fuels-template-preview ⬜️ Ignored (Inspect) Aug 27, 2024 5:36pm

@petertonysmith94 petertonysmith94 merged commit da9bc81 into FuelLabs:master Aug 27, 2024
23 checks passed
@aditya172926 aditya172926 deleted the aditya172926/chore/typedoc-plugin-markdown branch October 6, 2024 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Issue is a chore
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Upgrade typedoc dependency Upgrade typedoc-plugin-markdown dependency
7 participants