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 typedoc.yml to also trigger on prereleases #172

Merged
merged 1 commit into from
Nov 30, 2023

Conversation

maxxfrazer
Copy link
Contributor

What kind of pull request did you make?

  • Other - Build update

Changelog

Build of typed was not firing when releases were marked as pre-releases. Since the latest version is still a beta, that means that the docs were never attached to the release.

Copy link
Contributor

Coverage Summary for `./packages/agora-rtc-react`

Status Category Percentage Covered / Total
🔵 Lines 95.16% 2518 / 2646
🔵 Statements 95.16% 2518 / 2646
🔵 Functions 86.95% 40 / 46
🔵 Branches 88.98% 210 / 236
File Coverage
File Stmts % Branch % Funcs % Lines Uncovered Lines
packages/agora-rtc-react/src/error.ts 100% 100% 100% 100%
packages/agora-rtc-react/src/index.ts 100% 100% 100% 100%
packages/agora-rtc-react/src/types.ts 100% 100% 100% 100%
packages/agora-rtc-react/src/components/LocalAudioTrack.tsx 100% 100% 100% 100%
packages/agora-rtc-react/src/components/LocalUser.tsx 100% 100% 100% 100%
packages/agora-rtc-react/src/components/LocalVideoTrack.tsx 100% 100% 100% 100%
packages/agora-rtc-react/src/components/RemoteAudioTrack.tsx 100% 100% 100% 100%
packages/agora-rtc-react/src/components/RemoteUser.tsx 100% 100% 100% 100%
packages/agora-rtc-react/src/components/RemoteVideoTrack.tsx 100% 100% 100% 100%
packages/agora-rtc-react/src/components/TrackBoundary.tsx 67.29% 88.88% 50% 67.29% 21-60, 87-94, 116-117, 148-149
packages/agora-rtc-react/src/components/UserCover.tsx 95.83% 50% 100% 95.83% 43-44
packages/agora-rtc-react/src/hooks/events.ts 93.29% 100% 0% 93.29% 417-436, 522-537
packages/agora-rtc-react/src/hooks/useConnectionState.ts 92.15% 44.44% 100% 92.15% 37-38, 46-47
packages/agora-rtc-react/src/hooks/useCurrentUID.ts 95.12% 75% 100% 95.12% 31-32
packages/agora-rtc-react/src/hooks/useIsConnected.ts 89.36% 50% 100% 89.36% 35-37, 42-43
packages/agora-rtc-react/src/hooks/useJoin.ts 98.24% 85.71% 100% 98.24% 99-100
packages/agora-rtc-react/src/hooks/useLocalCameraTrack.ts 100% 100% 100% 100%
packages/agora-rtc-react/src/hooks/useLocalMicrophoneTrack.ts 100% 100% 100% 100%
packages/agora-rtc-react/src/hooks/useLocalScreenTrack.ts 100% 100% 100% 100%
packages/agora-rtc-react/src/hooks/useNetworkQuality.ts 95.83% 66.66% 100% 95.83% 43-44
packages/agora-rtc-react/src/hooks/usePublish.ts 93.69% 75% 100% 93.69% 60-65, 68
packages/agora-rtc-react/src/hooks/useRTCClient.tsx 100% 100% 100% 100%
packages/agora-rtc-react/src/hooks/useRTCScreenShareClient.tsx 53.84% 100% 0% 53.84% 13-21, 24-26
packages/agora-rtc-react/src/hooks/useRemoteAudioTracks.ts 98.84% 88% 100% 98.84% 79, 81
packages/agora-rtc-react/src/hooks/useRemoteUserTrack.ts 100% 100% 100% 100%
packages/agora-rtc-react/src/hooks/useRemoteUsers.ts 100% 75% 100% 100%
packages/agora-rtc-react/src/hooks/useRemoteVideoTracks.ts 98.82% 88% 100% 98.82% 78, 80
packages/agora-rtc-react/src/hooks/useVolumeLevel.ts 100% 100% 100% 100%

@guoxianzhe
Copy link
Collaborator

@maxxfrazer typedoc can trigger when push to main. You can check at here

@maxxfrazer
Copy link
Contributor Author

maxxfrazer commented Nov 30, 2023

@maxxfrazer typedoc can trigger when push to main. You can check at here

By triggering on the releases it can attach a zip of the typedoc API Reference to be attached to the same release, as we do in flutter releases and others


This is how the en api references are updated

@guoxianzhe guoxianzhe merged commit 74f81e7 into main Nov 30, 2023
4 checks passed
@guoxianzhe guoxianzhe deleted the typedoc-beta-release branch November 30, 2023 11:47
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.

2 participants