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

fix: jsdoc errors due to unrecognized format #557

Merged
merged 2 commits into from
Sep 10, 2024
Merged

Conversation

JeffreyDallas
Copy link
Contributor

@JeffreyDallas JeffreyDallas commented Sep 10, 2024

Description

Fixed some jsdoc errors because it did not support some auto generated mjs documentation styles.
Also run jsdoc when doing syntax format check so we do not need separate jsdoc check from ci flow as mentioned in #544

Related Issues

Signed-off-by: Jeffrey Tang <[email protected]>
@JeffreyDallas JeffreyDallas requested review from leninmehedy and a team as code owners September 10, 2024 14:56
Copy link
Contributor

github-actions bot commented Sep 10, 2024

Unit Test Results - Linux

  1 files  ±0   19 suites  ±0   25s ⏱️ -2s
122 tests ±0  122 ✅ ±0  0 💤 ±0  0 ❌ ±0 
148 runs  ±0  148 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit ed06b26. ± Comparison against base commit 12142c2.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Sep 10, 2024

Unit Test Results - Windows

  1 files  ±0   19 suites  ±0   52s ⏱️ -9s
122 tests ±0  122 ✅ ±0  0 💤 ±0  0 ❌ ±0 
148 runs  ±0  148 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit ed06b26. ± Comparison against base commit 12142c2.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Sep 10, 2024

E2E Node PEM Stop Tests Coverage Report

13 tests  ±0   13 ✅ +2   2m 42s ⏱️ - 1m 39s
 1 suites ±0    0 💤  - 1 
 1 files   ±0    0 ❌  - 1 

Results for commit ed06b26. ± Comparison against base commit 12142c2.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Sep 10, 2024

E2E Relay Tests Coverage Report

1 files  ±0  1 suites  ±0   2m 49s ⏱️ +16s
6 tests ±0  6 ✅ ±0  0 💤 ±0  0 ❌ ±0 
7 runs  ±0  7 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit ed06b26. ± Comparison against base commit 12142c2.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Sep 10, 2024

E2E Node PEM Kill Tests Coverage Report

13 tests  ±0   13 ✅ ±0   2m 47s ⏱️ -1s
 1 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit ed06b26. ± Comparison against base commit 12142c2.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Sep 10, 2024

E2E Node Local Build Tests Coverage Report

10 tests  ±0   10 ✅ ±0   2m 26s ⏱️ +3s
 2 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit ed06b26. ± Comparison against base commit 12142c2.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Sep 10, 2024

E2E Mirror Node Tests Coverage Report

 1 files  ±0   1 suites  ±0   3m 41s ⏱️ -11s
13 tests ±0  13 ✅ ±0  0 💤 ±0  0 ❌ ±0 
14 runs  ±0  14 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit ed06b26. ± Comparison against base commit 12142c2.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Sep 10, 2024

E2E Tests Coverage Report

58 tests  ±0   58 ✅ ±0   4m 25s ⏱️ ±0s
 9 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit ed06b26. ± Comparison against base commit 12142c2.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Sep 10, 2024

E2E Node Update Tests Coverage Report

12 tests  ±0   12 ✅ ±0   5m 33s ⏱️ +3s
 1 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit ed06b26. ± Comparison against base commit 12142c2.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Sep 10, 2024

E2E Node Delete Tests Coverage Report

10 tests  ±0   10 ✅ ±0   6m 16s ⏱️ +3s
 1 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit ed06b26. ± Comparison against base commit 12142c2.

♻️ This comment has been updated with latest results.

Signed-off-by: Jeffrey Tang <[email protected]>
@JeffreyDallas JeffreyDallas requested a review from a team as a code owner September 10, 2024 15:05
Copy link
Contributor

E2E Node Add Tests Coverage Report

22 tests  ±0   22 ✅ ±0   14m 14s ⏱️ +13s
 2 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit ed06b26. ± Comparison against base commit 12142c2.

Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
Report missing for 12142c21
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (12142c2) Report Missing Report Missing Report Missing
Head commit (ed06b26) 4035 3171 78.59%

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#557) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

Footnotes

  1. Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct.

Copy link

codecov bot commented Sep 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.17%. Comparing base (c81c76a) to head (ed06b26).
Report is 57 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #557      +/-   ##
==========================================
+ Coverage   81.66%   83.17%   +1.51%     
==========================================
  Files          35       36       +1     
  Lines        4429     4815     +386     
  Branches      671      742      +71     
==========================================
+ Hits         3617     4005     +388     
+ Misses        812      810       -2     
Files with missing lines Coverage Δ
src/commands/index.mjs 0.00% <ø> (ø)
src/commands/init.mjs 78.94% <ø> (ø)
src/commands/node.mjs 85.07% <ø> (+6.32%) ⬆️
src/commands/relay.mjs 72.72% <ø> (ø)
src/core/constants.mjs 94.25% <ø> (-0.20%) ⬇️
...rc/core/dependency_managers/dependency_manager.mjs 100.00% <100.00%> (ø)
src/core/k8.mjs 87.46% <ø> (+0.98%) ⬆️
src/core/platform_installer.mjs 88.80% <ø> (+2.35%) ⬆️

... and 5 files with indirect coverage changes

Impacted file tree graph

@JeffreyDallas JeffreyDallas changed the title fix: jsdoc errors fix: jsdoc errors due to unrecognized format Sep 10, 2024
@JeffreyDallas JeffreyDallas merged commit da7113b into main Sep 10, 2024
43 of 44 checks passed
@JeffreyDallas JeffreyDallas deleted the 00543-fix-js-doc branch September 10, 2024 19:33
swirlds-automation added a commit that referenced this pull request Sep 17, 2024
## [0.30.0](v0.29.0...v0.30.0) (2024-09-17)

### Features

* add node add-prepare and node add-execute commands ([#533](#533)) ([a184775](a184775))
* add support for attach jvm debugger ([#549](#549)) ([35a0075](35a0075))
* add the autogen tool to easily add e2e tests and run it for the first time & fix copyFrom ([#566](#566)) ([e6c79eb](e6c79eb))
* **network node livecheck:** implement a functionality to determine network node activeness with prometheus metrics ([#567](#567)) ([6120775](6120775))
* remove pfx support ([#537](#537)) ([aff5f63](aff5f63))

### Bug Fixes

* aligned test names to naming pattern ([#554](#554)) ([365f724](365f724))
* download application.properties file if it was generated by hedera app during handling address book change ([#571](#571)) ([35c73d8](35c73d8))
* **functionality:** removed the 'z' from the 'tar' command on the K8.copyFrom ([#561](#561)) ([796474b](796474b))
* have update readme run after version calculation in deploy and release ([#586](#586)) ([42e1685](42e1685))
* jsdoc errors due to unrecognized format ([#557](#557)) ([da7113b](da7113b))
* remove of using agreement key in hedera repo test ([#563](#563)) ([05c5517](05c5517))
* separate repeated steps as individual functions ([#562](#562)) ([dcbbe5e](dcbbe5e))
@swirlds-automation
Copy link
Contributor

🎉 This PR is included in version 0.30.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
3 participants