Add SDK Typedoc Implementation for v3 Client #701

ajimae · 2024-05-09T00:14:09Z

Summary

Add SDK Typedoc Implementation for v3 Client

Completed Tasks

restructure configurations to for monorepo/workspace mode
add individual tsconfig.json and typedoc.json config files
add base tsconfig.base.json and typedoc.base.json to hold common configurations
specify namespaces for each module or packages
update github actions workflow file to script Version Package PRs

- restructure configurations to for monorepo/workspace mode - add individual tsconfig.json and typedoc.json config files - add base tsconfig.base.json and typedoc.base.json to hold common configurations - specify namespaces for each module or packages - update github actions workflow file to script Version Package PRs

changeset-bot · 2024-05-09T00:14:12Z

⚠️ No Changeset found

Latest commit: 4140086

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

- remove the files configuration

codecov · 2024-05-09T00:32:55Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.83%. Comparing base (30d3ac5) to head (4140086).

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #701   +/-   ##
=======================================
  Coverage   92.83%   92.83%           
=======================================
  Files          25       25           
  Lines         279      279           
  Branches       12       12           
=======================================
  Hits          259      259           
  Misses         20       20

Flag	Coverage Δ
integrationtests	`92.83% <ø> (ø)`

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

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

- update docs.yml workflow file

lojzatran · 2024-05-09T07:53:43Z

.github/workflows/docs.yml

@@ -1,15 +1,14 @@
 name: SDK Type Docs Specification
 on:
-  push:


Can you explain why you removed this part? Will it now be deployed on every PR?

This was remove because of double deployment, as it will be deployed both for all PRs and also when the PR is merged which I don't think is necessary.

And it will be available in GH pages? How will it ensure that PR won‘t overwrite the current docs on master if there is only 1 URL for the GH pages?

I am not sure I understand, but how it works is that any changes made through a PR will build a new version of the docs and deploy it to gh-pages. This is to ensure that whatever modification is made to the SDK will automatically be updated in the docs.

And also, there is no docs in the master, all the docs are built and deployed to gh-pages during PR builds.

But then if the docs changes in PR is deployed to the gh-pages, the docs will be available to the users, but they will not see the correct classes in the sdk because the PR is not merged to master?

This doesn't matter, it is not as if the PR will take forever before it is merged. I think the time between raising the PR and getting it merged is relatively short to worry about this scenario.

Well that is not how the official docs work, if we have to look at it this way, the javadoc doesn't show any deployment in the PR to see how the docs looks like, I don't think we should go with that approach.

The official docs gives you a preview link which can be inspected to see the changes before the PR is merged, I think this is a better approach than the javadocs implementation.

I agree, so this GH pages link is for a preview only?

Well that is not how the official docs work, if we have to look at it this way, the javadoc doesn't show any deployment in the PR to see how the docs looks like, I don't think we should go with that approach.
The official docs gives you a preview link which can be inspected to see the changes before the PR is merged, I think this is a better approach than the javadocs implementation.

I agree, so this GH pages link is for a preview only?

No, it's not only for previews, it's also the live gh-pages link. I can change the trigger to merge or release only, but doing this, we will lose our ability to see the updated docs before merging the PR (no preview deployment link) which was something I thought about before going with the PR trigger approach.

But if you still think we should deploy it on merge or release, then we can talk to the team about it to see which approach is more favourable.

Let‘s discuss it in the tooling weekly 👍

I think you mixed up the docs website with the ones for the SDK. The docs website publishes a preview for every PR using vercel. This is not the case for the SDK docs.

In the Java Repo we built the docs only for the main branch to see that it's not broken, but there is no deployment happening.

Deploy to the the GH pages happens only after a tag has been made or the build was triggered manually. This should be sufficient as the docs are mainly auto generated. Only manually written docs are sometimes built locally to check the look.

tsconfig.base.json

Co-authored-by: Jens Schulze <[email protected]>

- update doc.yml workflow file - update workflows to use repository dispatch

.github/workflows/docs.yml

.github/workflows/release.yml

ajimae requested a review from a team as a code owner May 9, 2024 00:14

ajimae had a problem deploying to github-pages May 9, 2024 00:14 — with GitHub Actions Failure

ajimae added 2 commits May 9, 2024 02:25

chore(tsconfig.json): update tsconfig.json file

94599b8

- remove the files configuration

chore(tsconfig.json): update tsconfig.json file

0de3194

- remove the files configuration

ajimae had a problem deploying to github-pages May 9, 2024 00:28 — with GitHub Actions Failure

chore(tsconfig.json): update actions workflow file

6a83e90

- update docs.yml workflow file

ajimae had a problem deploying to github-pages May 9, 2024 00:37 — with GitHub Actions Failure

chore(tsconfig.json): update actions workflow file

05a917d

- update docs.yml workflow file

ajimae had a problem deploying to github-pages May 9, 2024 00:39 — with GitHub Actions Failure

chore(tsconfig.json): update actions workflow file

f91c2ae

- update docs.yml workflow file

ajimae had a problem deploying to github-pages May 9, 2024 00:42 — with GitHub Actions Failure

chore(tsconfig.json): update actions workflow file

b19c045

- update docs.yml workflow file

ajimae had a problem deploying to github-pages May 9, 2024 00:44 — with GitHub Actions Failure

ajimae had a problem deploying to github-pages May 9, 2024 00:45 — with GitHub Actions Failure

chore(tsconfig.json): update actions workflow file

11b3af6

- update docs.yml workflow file

ajimae temporarily deployed to github-pages May 9, 2024 01:00 — with GitHub Actions Inactive

ajimae requested review from lojzatran and jenschude May 9, 2024 01:02

lojzatran reviewed May 9, 2024

View reviewed changes

jenschude reviewed May 13, 2024

View reviewed changes

tsconfig.base.json Outdated Show resolved Hide resolved

Update tsconfig.base.json

5eceb32

Co-authored-by: Jens Schulze <[email protected]>

ajimae temporarily deployed to github-pages May 13, 2024 09:37 — with GitHub Actions Inactive

ajimae and others added 2 commits May 13, 2024 13:38

chore(doc.yml): update doc.yml file

acd0f49

- update doc.yml workflow file - update workflows to use repository dispatch

Merge branch 'master' into feat/implement-complete-sdk-specs-v3

d9959f9

ajimae requested review from jenschude and lojzatran May 14, 2024 05:46

jenschude reviewed May 14, 2024

View reviewed changes

.github/workflows/docs.yml Outdated Show resolved Hide resolved

.github/workflows/docs.yml Show resolved Hide resolved

.github/workflows/release.yml Outdated Show resolved Hide resolved

jenschude added 2 commits May 14, 2024 08:50

Apply suggestions from code review

ffe5276

chore(docs): emit docs for all packages

4140086

ajimae merged commit 787057c into master May 14, 2024
6 checks passed

ajimae deleted the feat/implement-complete-sdk-specs-v3 branch May 14, 2024 13:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SDK Typedoc Implementation for v3 Client #701

Add SDK Typedoc Implementation for v3 Client #701

ajimae commented May 9, 2024

changeset-bot bot commented May 9, 2024 •

edited

Loading

codecov bot commented May 9, 2024 •

edited

Loading

lojzatran May 9, 2024

ajimae May 9, 2024

lojzatran May 9, 2024

ajimae May 9, 2024

ajimae May 9, 2024

ajimae May 9, 2024

lojzatran May 9, 2024

ajimae May 9, 2024

lojzatran May 9, 2024

jenschude May 13, 2024

Add SDK Typedoc Implementation for v3 Client #701

Add SDK Typedoc Implementation for v3 Client #701

Conversation

ajimae commented May 9, 2024

Summary

Completed Tasks

changeset-bot bot commented May 9, 2024 • edited Loading

⚠️ No Changeset found

codecov bot commented May 9, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

changeset-bot bot commented May 9, 2024 •

edited

Loading

codecov bot commented May 9, 2024 •

edited

Loading