docs: self contained examples by Ivo-Yankov · Pull Request #2384 · hiero-ledger/solo

Ivo-Yankov · 2025-07-31T13:43:54Z

Description

Refactored all examples to be completely self-contained within their directory without requiring external files.
Simplified the taskfiles in all examples
Removed all performance-test examples
Moved the main Taskfile from /examples, the solo-gke-test example and the create-topic.js script to a separate scripts directory.
Fixed an issue in the solo explorer deploy command that could result in a Cannot read property of undefined error.

Related Issues

Closes Refactor examples to be self-contained #2346
Closes Remove performance examples #2345
Closes add a readme to examples/external-database-test better explaining what is going on and how to use it #1536
Related to #

Pull request (PR) checklist

This PR added tests (unit, integration, and/or end-to-end)
This PR updated documentation
This PR added no TODOs or commented out code
This PR has no breaking changes
Any technical debt has been documented as a separate issue and linked to this PR
Any package.json changes have been explained to and approved by a repository manager
All related issues have been linked to this PR
All changes in this PR are included in the description
When this PR merges the commits will be squashed and the title will be used as the commit message, the 'commit message guidelines' below have been followed

Testing

This PR added unit tests
This PR added integration/end-to-end tests
These changes required manual testing that is documented below
Anything not tested is documented

The following manual testing was done:

TBD

The following was not tested:

TBD

Commit message guidelines

We use 'Conventional Commits' to ensure that our commit messages are easy to read, follow a consistent format, and for automated release note generation. Please follow the guidelines below when writing your commit messages:

BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. NOTE: currently breaking changes will only bump the MAJOR version.
The title is prefixed with one of the following:

Prefix	Description	Semantic Version Update	Captured in Release Notes
feat:	a new feature	MINOR	Yes
fix:	a bug fix	PATCH	Yes
perf:	performance	PATCH	Yes
refactor:	code change that isn't feature or fix	none	No
test:	adding missing tests	none	No
docs:	changes to documentation	none	Yes
build:	changes to build process	none	No
ci:	changes to CI configuration	none	No
style:	formatting, missing semi-colons, etc	none	No
chore:	updating grunt tasks etc; no production code change	none	No

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

github-actions · 2025-07-31T13:46:42Z

Unit Test Results - Linux

32 tests ±0 32 ✅ ±0 0s ⏱️ ±0s
16 suites ±0 0 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit 6df195d. ± Comparison against base commit 6ce2568.

♻️ This comment has been updated with latest results.

github-actions · 2025-07-31T13:50:23Z

Unit Test Results - Windows

1 files ±0 177 suites ±0 3s ⏱️ -1s
494 tests ±0 494 ✅ ±0 0 💤 ±0 0 ❌ ±0
498 runs ±0 498 ✅ ±0 0 💤 ±0 0 ❌ ±0

Results for commit 6df195d. ± Comparison against base commit 6ce2568.

♻️ This comment has been updated with latest results.

github-actions · 2025-07-31T14:44:33Z

E2E Test Report

19 files - 1 136 suites - 3 1h 57m 38s ⏱️ - 11m 59s
363 tests - 16 363 ✅ - 16 0 💤 ±0 0 ❌ ±0
376 runs - 16 376 ✅ - 16 0 💤 ±0 0 ❌ ±0

Results for commit 6df195d. ± Comparison against base commit 6ce2568.

This pull request removes 16 tests.

Enable port-forward for mirror node gRPC ‑ External Database E2E Test Suite External Database E2E Test Enable port-forward for mirror node gRPC
external-database-test: JSON-RPC relay deploy ‑ External Database E2E Test Suite External Database E2E Test external-database-test: JSON-RPC relay deploy
external-database-test: explorer deploy ‑ External Database E2E Test Suite External Database E2E Test external-database-test: explorer deploy
external-database-test: mirror node deploy with external database ‑ External Database E2E Test Suite External Database E2E Test external-database-test: mirror node deploy with external database
external-database-test: network deploy ‑ External Database E2E Test Suite External Database E2E Test external-database-test: network deploy
external-database-test: node keys ‑ External Database E2E Test Suite External Database E2E Test external-database-test: node keys
external-database-test: node setup ‑ External Database E2E Test Suite External Database E2E Test external-database-test: node setup
external-database-test: node start ‑ External Database E2E Test Suite External Database E2E Test external-database-test: node start
external-database-test: solo cluster-ref connect ‑ External Database E2E Test Suite External Database E2E Test external-database-test: solo cluster-ref connect
external-database-test: solo cluster-ref setup ‑ External Database E2E Test Suite External Database E2E Test external-database-test: solo cluster-ref setup
…

♻️ This comment has been updated with latest results.

codacy-production · 2025-07-31T14:44:59Z

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00% (target: -1.00%)	✅ 100.00%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`6ce2568`)	41965	36032	85.86%
Head commit (`6df195d`)	41969 (+4)	36036 (+4)	85.86% (+0.00%)

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 (#2384)	6	6	100.00%

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

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

examples/README.md

Signed-off-by: Jeffrey Tang <jeffrey@swirldslabs.com>

examples/external-database-test/Taskfile.yml

Taskfile.tests.yml

examples/address-book/README.md

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

# Conflicts: # test/e2e/commands/tests/mirror-node-test.ts

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

# Conflicts: # src/commands/explorer.ts

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

examples/external-database-test/Taskfile.yml

Taskfile.tests.yml

examples/network-with-block-node/Taskfile.yml

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

# Conflicts: # .github/workflows/zxc-e2e-test.yaml

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

swirlds-automation · 2025-08-15T19:43:39Z

🎉 This PR is included in version 0.43.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

swirlds-automation · 2025-09-09T16:54:35Z

🎉 This PR is included in version 0.43.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Ivo-Yankov added 8 commits July 29, 2025 14:31

wip: refactor examples

28364fe

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

wip: refactor examples

1fade7f

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

chore: move create-topic script to new directory

2082b38

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

wip: format taskfiles and readmes

da25c58

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

chore: revert unintentional change

a8a0470

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

docs: update readme

6731273

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

Merge branch 'refs/heads/main' into 02346-self-contained-examples

a1ec4d8

chore: revert package-lock changes

7ad8628

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

Ivo-Yankov self-assigned this Jul 31, 2025

Ivo-Yankov added 3 commits August 1, 2025 15:01

docs: update address-book readme

55256b1

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

fix: use local solo installation

8065ff0

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

fix: revert deleted taskfile

4000510

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

Ivo-Yankov marked this pull request as ready for review August 4, 2025 09:44

Ivo-Yankov requested review from a team as code owners August 4, 2025 09:44

Ivo-Yankov requested review from jeromy-cannon, nathanklick and rbarker-dev August 4, 2025 09:44

Ivo-Yankov added the PR: Needs Team Approval A pull request that needs review from a team member. label Aug 4, 2025

Merge branch 'main' into 02346-self-contained-examples

816da36

JeffreyDallas reviewed Aug 5, 2025

View reviewed changes

examples/README.md Show resolved Hide resolved

save

6bd9612

Signed-off-by: Jeffrey Tang <jeffrey@swirldslabs.com>

jeromy-cannon reviewed Aug 6, 2025

View reviewed changes

examples/external-database-test/Taskfile.yml Outdated Show resolved Hide resolved

Taskfile.tests.yml Show resolved Hide resolved

examples/address-book/README.md Show resolved Hide resolved

Ivo-Yankov added 2 commits August 7, 2025 16:24

chore: resolving comments

616bac7

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

Merge branch 'refs/heads/main' into 02346-self-contained-examples

e203eed

# Conflicts: # test/e2e/commands/tests/mirror-node-test.ts

jeromy-cannon added the PR: Unresolved Comments A pull request where there are comments and they need to be resolved. label Aug 8, 2025

Ivo-Yankov added 5 commits August 11, 2025 14:13

chore: resolve comments

9423622

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

Merge branch 'refs/heads/main' into 02346-self-contained-examples

3db5617

# Conflicts: # src/commands/explorer.ts

feat: build examples readme for hugo

647bdcf

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

chore: fix update_md script

c0630c3

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

feat: add example readmes to site

42f0275

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

Ivo-Yankov added PR: Needs Team Approval A pull request that needs review from a team member. and removed PR: Unresolved Comments A pull request where there are comments and they need to be resolved. labels Aug 12, 2025

jeromy-cannon requested changes Aug 12, 2025

View reviewed changes

examples/external-database-test/Taskfile.yml Show resolved Hide resolved

Taskfile.tests.yml Show resolved Hide resolved

examples/network-with-block-node/Taskfile.yml Outdated Show resolved Hide resolved

jeromy-cannon added PR: Unresolved Comments A pull request where there are comments and they need to be resolved. and removed PR: Needs Team Approval A pull request that needs review from a team member. labels Aug 12, 2025

Ivo-Yankov added 5 commits August 13, 2025 12:20

chore: revert deletion of external db example

843d406

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

chore: small fixes

deec94e

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

fix: typo

dd57d45

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

Merge branch 'main' into 02346-self-contained-examples

20023a7

fix: update script references

8aa6570

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

jeromy-cannon added the PR: Merge Conflicts A pull request that has merge conflicts that need to be resolved. label Aug 13, 2025

Merge branch 'main' into 02346-self-contained-examples

27c033b

# Conflicts: # .github/workflows/zxc-e2e-test.yaml

Ivo-Yankov removed the PR: Merge Conflicts A pull request that has merge conflicts that need to be resolved. label Aug 14, 2025

Ivo-Yankov added 2 commits August 14, 2025 13:18

fix: merge issues

0d49aa0

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

fix: run setup step for e2e-external-database

6df195d

Signed-off-by: Ivo Yankov <ivo@devlabs.bg>

Ivo-Yankov added PR: Needs Team Approval A pull request that needs review from a team member. and removed PR: Unresolved Comments A pull request where there are comments and they need to be resolved. labels Aug 14, 2025

jeromy-cannon approved these changes Aug 14, 2025

View reviewed changes

jeromy-cannon merged commit 6e438e6 into main Aug 14, 2025
43 checks passed

jeromy-cannon deleted the 02346-self-contained-examples branch August 14, 2025 15:31

swirlds-automation added the released label Aug 15, 2025

swirlds-automation added the released on @0.43.x label Sep 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: self contained examples#2384

docs: self contained examples#2384
jeromy-cannon merged 29 commits intomainfrom
02346-self-contained-examples

Ivo-Yankov commented Jul 31, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 31, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 31, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 31, 2025 •

edited

Loading

Uh oh!

codacy-production bot commented Jul 31, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

swirlds-automation commented Aug 15, 2025

Uh oh!

swirlds-automation commented Sep 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

Ivo-Yankov commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Pull request (PR) checklist

Testing

Uh oh!

github-actions bot commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Test Results - Linux

Uh oh!

github-actions bot commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Test Results - Windows

Uh oh!

github-actions bot commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

E2E Test Report

Uh oh!

codacy-production bot commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage summary from Codacy

See diff coverage on Codacy

See your quality gate settings Change summary preferences

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

swirlds-automation commented Aug 15, 2025

Uh oh!

swirlds-automation commented Sep 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Ivo-Yankov commented Jul 31, 2025 •

edited

Loading

github-actions bot commented Jul 31, 2025 •

edited

Loading

github-actions bot commented Jul 31, 2025 •

edited

Loading

github-actions bot commented Jul 31, 2025 •

edited

Loading

codacy-production bot commented Jul 31, 2025 •

edited

Loading