ci: auto update readme

[JeffreyDallas]

Description

This pull request changes the following:

• Auto update example output part of Readme
• Creating a template file README.md.template from existing README.md, and adding some environment variables to replace previous example outputs sections
• Saving command line outputs from solo/kind to environment variables.
• Then using linux utility envsubst to replace these pre-defined environment variables in README.md.template
• Only changing README.md if the number of changed lines greater than a certain threshold
• Only trigger trigger the workflow if source code changes

Related Issues

• Closes Generate CLI command examples using CI pipeline #121

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
Report missing for dea5ea51	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (dea5ea5)	Report Missing	Report Missing	Report Missing
Head commit (8124708)	2597	1988	76.55%

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 (#206)	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

_{You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation}

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. ↩

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.10%. Comparing base (fef8a48) to head (45ece8a).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #206      +/-   ##
==========================================
- Coverage   77.13%   77.10%   -0.03%     
==========================================
  Files          33       33              
  Lines        3415     3415              
  Branches      562      562              
==========================================
- Hits         2634     2633       -1     
- Misses        781      782       +1     

see 1 file with indirect coverage changes

[github-actions]

Unit Test Results

  1 files  ±0   17 suites  ±0   1m 11s ⏱️ -14s
114 tests ±0  114 ✅ ±0  0 💤 ±0  0 ❌ ±0 
139 runs  ±0  139 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 45ece8a. ± Comparison against base commit fef8a48.

♻️ This comment has been updated with latest results.

[github-actions]

E2E Test Results

 1 files  ±0  10 suites  ±0   8m 0s ⏱️ - 2m 41s
74 tests ±0  74 ✅ ±0  0 💤 ±0  0 ❌ ±0 
76 runs  ±0  76 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 45ece8a. ± Comparison against base commit fef8a48.

♻️ This comment has been updated with latest results.

[JeffreyDallas]

I was able to remove lines contain these unwanted special character as well as escape color code,
but still the output no longer have indent to showing subtask status.
Example, the line started with Check dependency: helm

Before

✔ Setup home directory and cache
✔ Check dependencies
  ✔ Check dependency: helm [OS: darwin, Release: 23.3.0, Arch: arm64]
✔ Setup chart manager [0.9s]
✔ Copy configuration file templates

After

❯ Setup home directory and cache
✔ Setup home directory and cache
❯ Check dependencies
❯ Check dependency: helm [OS: darwin, Release: 23.3.0, Arch: arm64]
✔ Check dependency: helm [OS: darwin, Release: 23.3.0, Arch: arm64]
✔ Check dependencies
❯ Setup chart manager
✔ Setup chart manager
❯ Copy configuration file templates

[wiz-inc-8f76296f7c]

Wiz Scan Summary

IaC Misconfigurations
Vulnerabilities
Sensitive Data
Total
Secrets

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ -0.13% (target: -1.00%)	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (dea5ea5)	2594	1986	76.56%
Head commit (ca76a99)	2597 (+3)	1985 (-1)	76.43% (-0.13%)

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 (#206)	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 will stop sending the deprecated coverage status from June 5th, 2024. Learn more}

[swirlds-automation]

🎉 This PR is included in version 0.24.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[swirlds-automation]

🎉 This PR is included in version 0.24.0 🎉

The release is available on:

• npm package (@release-0.24.x dist-tag)
• GitHub release

Your semantic-release bot 📦🚀