ts(docs): Add typedoc to client hosted with GHPages - #648
Conversation
|
CodeAnt AI is reviewing your PR. Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
|
CodeAnt AI finished reviewing your PR. |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
|
CodeAnt AI is running Incremental review Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
codeant-ai
Bot
added
the
size:XXL
|
CodeAnt AI Incremental review completed. |
|
CodeAnt AI is running Incremental review Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
codeant-ai
Bot
added
size:XXL
|
CodeAnt AI Incremental review completed. |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
dines-rl
changed the title
|
CodeAnt AI is running Incremental review Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
dines-rl
changed the title
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
codeant-ai
Bot
added
size:XXL
|
CodeAnt AI Incremental review completed. |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
sid-rl
left a comment
sid-rl
left a comment
There was a problem hiding this comment.
Looks good to me! Make sure to change all imports in test files to .../src/sdk/... instead of .../src/objects/...
|
| Metric | Coverage | Required | Status |
|---|---|---|---|
| Functions | 0% | 100% | ❌ |
| Lines | 0% | - | ℹ️ |
| Branches | 0% | - | ℹ️ |
| Statements | 0% | - | ℹ️ |
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests)
View detailed coverage report
Coverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%.
|
| Metric | Coverage | Required | Status |
|---|---|---|---|
| Functions | 0% | 100% | ❌ |
| Lines | 0% | - | ℹ️ |
| Branches | 0% | - | ℹ️ |
| Statements | 0% | - | ℹ️ |
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests)
View detailed coverage report
Coverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%.
|
| Metric | Coverage | Required | Status |
|---|---|---|---|
| Functions | 0% | 100% | ❌ |
| Lines | 0% | - | ℹ️ |
| Branches | 0% | - | ℹ️ |
| Statements | 0% | - | ℹ️ |
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests)
View detailed coverage report
Coverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%.
|
| Metric | Coverage | Required | Status |
|---|---|---|---|
| Functions | 0% | 100% | ❌ |
| Lines | 0% | - | ℹ️ |
| Branches | 0% | - | ℹ️ |
| Statements | 0% | - | ℹ️ |
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests)
View detailed coverage report
Coverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%.
jrvb-rl
left a comment
jrvb-rl
left a comment
There was a problem hiding this comment.
A few minor questions.
I skimmed over the new internal docs - presumably there is a better way to look at those, so I can do that next and add more comments to the PR if I find any issues.
| - name: tar the existing docs | ||
| run: | | ||
| mkdir -p ./docs | ||
| tar -cvf documentation.tar ./docs |
There was a problem hiding this comment.
if there is no .docs dir, should we create an error rather than an empty tar file? I assume things would just fail if the tar command exits with nonzero status, so just taking out the mkdir would do the trick?
There was a problem hiding this comment.
this is within the GH page repo, so if it doesn't exist it makes an empty one if it does it tars it up
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: documentation | ||
| - run: tar -xf documentation.tar ./docs -C ./docs |
There was a problem hiding this comment.
Is there a reason we want to only untar things that start with ./docs? (probably fine given how the archive is created, but maybe would be confusing if we add more dirs later and they don't show up?)
There was a problem hiding this comment.
this is just for GH pages so yeah just that one
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: newdocumentation | ||
| - run: tar -xf newdocumentation.tar ./docs -C ./docs |
There was a problem hiding this comment.
same comment here on the ./docs arg
| * - `success`: Boolean indicating if exit code is 0 | ||
| * - `failed`: Boolean indicating if exit code is non-zero |
There was a problem hiding this comment.
Do we really have both booleans? Why?
|
| Metric | Coverage | Required | Status |
|---|---|---|---|
| Functions | 99.07% | 100% | ❌ |
| Lines | 86.98% | - | ℹ️ |
| Branches | 57.3% | - | ℹ️ |
| Statements | 86.45% | - | ℹ️ |
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests)
View detailed coverage report
Coverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%.
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Please fix the failing tests before checking coverage. |
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
✅ Object Smoke Tests & Coverage ReportTest Results✅ All smoke tests passed Coverage Results
Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests) ✅ All tests passed and all object methods are covered! View detailed coverage reportCoverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%. |
3 participants
V1 of Typedocs for the Client