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

feat: update readme and hugo workflow #930

Merged
merged 20 commits into from
Dec 9, 2024

Conversation

JeffreyDallas
Copy link
Contributor

@JeffreyDallas JeffreyDallas commented Dec 5, 2024

Description

This PR is part of resolving issue 914

  • Split the original long README.md into many sections markdown documents
  • Manually verified that all testing steps, fixed some old / incorrect instrctions
  • Added new sections for CLI (may need further split)
  • Updated hugo main page to support the new strcuture.

Current results

Main readme:

https://github.com/hashgraph/solo/blob/00914-D-update-docu-workflow/README.md


image

JeffreyDallas and others added 4 commits December 5, 2024 11:23
Signed-off-by: Jeffrey Tang <[email protected]>
Signed-off-by: Jeffrey Tang <[email protected]>
Signed-off-by: Jeffrey Tang <[email protected]>
@JeffreyDallas JeffreyDallas requested review from a team and leninmehedy as code owners December 5, 2024 18:15
@JeffreyDallas JeffreyDallas marked this pull request as draft December 5, 2024 18:18
Signed-off-by: Jeffrey Tang <[email protected]>
@JeffreyDallas JeffreyDallas self-assigned this Dec 5, 2024
@JeffreyDallas JeffreyDallas marked this pull request as ready for review December 5, 2024 18:26
jeromy-cannon and others added 2 commits December 6, 2024 14:03
Copy link
Contributor

@jeromy-cannon jeromy-cannon left a comment

Choose a reason for hiding this comment

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

looks like we are getting autocommits in our PRs. Can we stop doing this? Also, your check code style is failing

@JeffreyDallas
Copy link
Contributor Author

looks like we are getting autocommits in our PRs. Can we stop doing this? Also, your check code style is failing

reverted the change of auto commit.
I was enabled it in test branch to see if template rendering still works after spliting up readme

Copy link
Contributor

github-actions bot commented Dec 6, 2024

Unit Test Results - Linux

  1 files  ± 0   53 suites  +3   2s ⏱️ -1s
216 tests +18  216 ✅ +18  0 💤 ±0  0 ❌ ±0 
226 runs  +18  226 ✅ +18  0 💤 ±0  0 ❌ ±0 

Results for commit 47e4085. ± Comparison against base commit a7bbae0.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Dec 6, 2024

Unit Test Results - Windows

  1 files  ± 0   53 suites  +3   12s ⏱️ -3s
216 tests +18  216 ✅ +18  0 💤 ±0  0 ❌ ±0 
226 runs  +18  226 ✅ +18  0 💤 ±0  0 ❌ ±0 

Results for commit 47e4085. ± Comparison against base commit a7bbae0.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Dec 6, 2024

E2E Test Report

 13 files  ±0  105 suites  ±0   55m 15s ⏱️ +17s
220 tests ±0  220 ✅ ±0  0 💤 ±0  0 ❌ ±0 
223 runs  ±0  223 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit e32595d. ± Comparison against base commit a7bbae0.

Copy link
Contributor

github-actions bot commented Dec 6, 2024

E2E Test Report

 13 files  ±0  105 suites  ±0   55m 54s ⏱️ +56s
220 tests ±0  220 ✅ ±0  0 💤 ±0  0 ❌ ±0 
223 runs  ±0  223 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 47e4085. ± Comparison against base commit a7bbae0.

♻️ This comment has been updated with latest results.

Copy link

codacy-production bot commented Dec 6, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.30% (target: -1.00%) 88.89%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (a7bbae0) 18307 15316 83.66%
Head commit (47e4085) 19039 (+732) 15985 (+669) 83.96% (+0.30%)

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 (#930) 9 8 88.89%

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

Copy link

codecov bot commented Dec 6, 2024

Codecov Report

Attention: Patch coverage is 88.88889% with 1 line in your changes missing coverage. Please review.

Project coverage is 82.91%. Comparing base (a7bbae0) to head (47e4085).
Report is 59 commits behind head on main.

Files with missing lines Patch % Lines
src/commands/node/tasks.ts 88.88% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #930      +/-   ##
==========================================
+ Coverage   82.61%   82.91%   +0.30%     
==========================================
  Files          67       71       +4     
  Lines       18335    19039     +704     
  Branches     1715     1486     -229     
==========================================
+ Hits        15148    15787     +639     
- Misses       3015     3161     +146     
+ Partials      172       91      -81     
Files with missing lines Coverage Δ
src/commands/node/tasks.ts 83.98% <88.88%> (-0.03%) ⬇️

... and 30 files with indirect coverage changes

Impacted file tree graph

Signed-off-by: Jeffrey Tang <[email protected]>
Signed-off-by: Jeffrey Tang <[email protected]>
Signed-off-by: Jeffrey Tang <[email protected]>
Copy link
Contributor

@mishomihov00 mishomihov00 left a comment

Choose a reason for hiding this comment

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

Review applies to
.github/workflows/flow-hugo-publish.yaml
.github/workflows/zxc-update-readme.yaml
docs/data/menu/main.yml

@jeromy-cannon jeromy-cannon merged commit 0e08abc into main Dec 9, 2024
38 of 39 checks passed
@jeromy-cannon jeromy-cannon deleted the 00914-D-update-docu-workflow branch December 9, 2024 14:38
swirlds-automation added a commit that referenced this pull request Dec 31, 2024
## [0.32.0](v0.31.1...v0.32.0) (2024-12-31)

### ⚠ BREAKING CHANGES

* update readme with warning about BREAKING CHANGE in this next release (#730)

### Features

* add ci test flow to test task command to launch solo ([#811](#811)) ([356f341](356f341))
* add example for using javascript SDK ([#832](#832)) ([1d9452e](1d9452e))
* add extended math utils and duration support ([#923](#923)) ([f5a69e7](f5a69e7))
* add separate commands for update ([#735](#735)) ([44c3132](44c3132))
* add solo smoke test to test flow ([#905](#905)) ([79410f0](79410f0))
* add support for flexible lease acquisition and production readiness ([#830](#830)) ([7fa86ad](7fa86ad))
* Add the ability to inject a ca certificate for use in gRPC and gRPC Web ([#753](#753)) ([2cd8a38](2cd8a38))
* add timeout flag to network destroy command ([#821](#821)) ([0fb570b](0fb570b))
* allow settings a reserved static IP address for the consensus nodes HAProxy and Envoy Proxy though the cli with flags ([#937](#937)) ([de9ec2e](de9ec2e))
* change mirror node and explorer from subchart to individual chart ([#743](#743)) ([58f0496](58f0496))
* Create a local config for storing configurations on the users machine ([#803](#803)) ([0a4382d](0a4382d))
* Create remote config  ([#862](#862)) ([e8fe739](e8fe739))
* dynamically construct the genesis-network.json and add it to the values file to be used during network deploy ([#982](#982)) ([1b9b7e6](1b9b7e6))
* expose pod check attempts and delays as environment controlled variables ([#812](#812)) ([a7b3279](a7b3279))
* Implement IOC ([#1010](#1010)) ([ed23a7b](ed23a7b))
* Implement solo context connect ([#863](#863)) ([782b3ec](782b3ec))
* Increase helm chart version and switch to use oci registry ([#788](#788)) ([1973275](1973275))
* **k8s:** introduce Kubernetes lease lock mechanism ([#707](#707)) ([f1b8089](f1b8089))
* new command to save state files and upload state files ([#849](#849)) ([d5a9a18](d5a9a18))
* removed caching of ConfigManager and its flags ([#713](#713)) ([76a61e3](76a61e3))
* Setup mirror node monitor pinger service ([#893](#893)) ([f4c4320](f4c4320))
* update `solo context connect` to connect to single remote cluster ([#993](#993)) ([c9711c5](c9711c5))
* Update document ([#956](#956)) ([b378937](b378937))
* update readme and hugo workflow ([#930](#930)) ([0e08abc](0e08abc))
* Validate a remote config ([#922](#922)) ([a7bbae0](a7bbae0))

### Bug Fixes

* add delay before calling script ([#955](#955)) ([76f4b81](76f4b81))
* allow expired leases to be overwritten ([#828](#828)) ([1fa1d78](1fa1d78))
* bump chart and hedera version,  re-enable node add ([#985](#985)) ([9cae011](9cae011))
* check if setup chart installed or not before network deploy ([#799](#799)) ([6930dab](6930dab))
* document typo ([#988](#988)) ([8e4fe04](8e4fe04))
* Error in `node update` separate commands when new admin key is not supplied ([#854](#854)) ([6e472b5](6e472b5))
* Examples of performance configs for HashSphere and Latitude ([#926](#926)) ([#957](#957)) ([928148b](928148b))
* fix missing file issues when running solo from npm install -g ([#736](#736)) ([2a5cfc1](2a5cfc1))
* fixed genesis-network.json file lock issue ([#1074](#1074)) ([e590516](e590516))
* flag check of node logs command and incorrect download source ([#848](#848)) ([03051f0](03051f0))
* inconsistent failures ([#866](#866)) ([13ea46d](13ea46d))
* local chart directory not being taken correctly ([#983](#983)) ([58e96e1](58e96e1))
* nextNode ID for release version > 0.56.0 ([#765](#765)) ([3b98dd6](3b98dd6))
* node id should start from `1` ([#884](#884)) ([d90c9b5](d90c9b5))
* node update with single node ([#981](#981)) ([74285bf](74285bf))
* patch issue with dist folder not showing up ([#733](#733)) ([077f989](077f989))
* performance improvements for node stop ([#986](#986)) ([437bbc6](437bbc6))
* refactored Taskfiles, fixed bugs with taskfile, lease interval, sdk node client connection, and commands missing quiet flag ([#978](#978)) ([7bb0e99](7bb0e99))
* remote config validation not working ([#967](#967)) ([88c2506](88c2506))
* resolve node update test failures ([#856](#856)) ([5e1c652](5e1c652))
* Revised example configs for Latitude deployment, automation friendly ([#1038](#1038)) ([434daf3](434daf3))
* undefined log output of namespace ([#764](#764)) ([ac15957](ac15957))

### Documentation

* update readme with warning about BREAKING CHANGE in this next release ([#730](#730)) ([06295f6](06295f6))
@swirlds-automation
Copy link
Contributor

🎉 This PR is included in version 0.32.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
Development

Successfully merging this pull request may close these issues.

4 participants