Skip to content

fix: update markdown documentation generation script#2449

Merged
jeromy-cannon merged 13 commits intomainfrom
02436-D-hugo-build
Aug 13, 2025
Merged

fix: update markdown documentation generation script#2449
jeromy-cannon merged 13 commits intomainfrom
02436-D-hugo-build

Conversation

@JeffreyDallas
Copy link
Copy Markdown
Contributor

@JeffreyDallas JeffreyDallas commented Aug 12, 2025

Description

This pull request changes the following:

Related Issues

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
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:
  1. 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.
  2. 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: Jeffrey Tang <jeffrey@swirldslabs.com>
Signed-off-by: Jeffrey Tang <jeffrey@swirldslabs.com>
Signed-off-by: Jeffrey Tang <jeffrey@swirldslabs.com>
@JeffreyDallas JeffreyDallas requested review from a team as code owners August 12, 2025 02:04
@JeffreyDallas JeffreyDallas self-assigned this Aug 12, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Aug 12, 2025

Unit Test Results - Linux

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

Results for commit 8eb8054. ± Comparison against base commit 22f5a04.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Aug 12, 2025

Unit Test Results - Windows

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

Results for commit 8eb8054. ± Comparison against base commit 22f5a04.

♻️ This comment has been updated with latest results.

Signed-off-by: Jeffrey Tang <jeffrey@swirldslabs.com>
@JeffreyDallas JeffreyDallas marked this pull request as draft August 12, 2025 03:01
Signed-off-by: Jeffrey Tang <jeffrey@swirldslabs.com>
Signed-off-by: Jeffrey Tang <jeffrey@swirldslabs.com>
@JeffreyDallas JeffreyDallas changed the title fix: generation script update_md.sh fix: update markdown documentation generation script update_md.sh Aug 12, 2025
@JeffreyDallas JeffreyDallas changed the title fix: update markdown documentation generation script update_md.sh fix: update markdown documentation generation script Aug 12, 2025
@JeffreyDallas
Copy link
Copy Markdown
Contributor Author

JeffreyDallas commented Aug 12, 2025

Test with the following cases

npm run solo-test -- --help

npm run solo-test -- account create --help

npm run solo-test -- account  --help

npm run solo-test -- block node add --help

npm run solo-test -- account create

npm run solo-test -- node start --help

Signed-off-by: Jeffrey Tang <jeffrey@swirldslabs.com>
Signed-off-by: Jeffrey Tang <jeffrey@swirldslabs.com>
Signed-off-by: Jeffrey Tang <jeffrey@swirldslabs.com>
@JeffreyDallas JeffreyDallas marked this pull request as ready for review August 12, 2025 16:21
Signed-off-by: Jeffrey Tang <jeffrey@swirldslabs.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Aug 12, 2025

E2E Test Report

 20 files  ±0  139 suites  ±0   2h 6m 16s ⏱️ - 1m 16s
379 tests ±0  379 ✅ ±0  0 💤 ±0  0 ❌ ±0 
392 runs  ±0  392 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 8eb8054. ± Comparison against base commit 22f5a04.

♻️ This comment has been updated with latest results.

@codacy-production
Copy link
Copy Markdown

codacy-production bot commented Aug 12, 2025

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
-0.01% (target: -1.00%) 44.44%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (22f5a04) 41958 36035 85.88%
Head commit (8eb8054) 41965 (+7) 36038 (+3) 85.88% (-0.01%)

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 (#2449) 9 4 44.44%

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

@jan-milenkov jan-milenkov added the PR: Needs Team Approval A pull request that needs review from a team member. label Aug 13, 2025
@jan-milenkov jan-milenkov added the PR: Needs Manager Approval A pull request that needs review from a manager. label Aug 13, 2025
@jeromy-cannon jeromy-cannon merged commit 328544a into main Aug 13, 2025
44 checks passed
@jeromy-cannon jeromy-cannon deleted the 02436-D-hugo-build branch August 13, 2025 14:17
swirlds-automation added a commit that referenced this pull request Aug 15, 2025
## [0.43.0](v0.42.0...v0.43.0) (2025-08-15)

### Features

* Add kubectl dependency manager ([#2422](#2422)) ([a482302](a482302))
* control block node version as environment variable ([#2472](#2472)) ([c678d90](c678d90))
* Docker build section ([#2433](#2433)) ([2578351](2578351))
* search next available tcp port for port forward function call ([#2362](#2362)) ([22f5a04](22f5a04))

### Bug Fixes

* disable the setting of the gRPC web endpoint when running for apps that are not CN, bump MN to v0.136.0 ([#2463](#2463)) ([16b7cb2](16b7cb2))
* Migrate to using @hiero-ledger/sdk ([#2452](#2452)) ([b9a7018](b9a7018))
* Remove requirement for kind dependency ([#2451](#2451)) ([974303c](974303c))
* update markdown documentation generation script ([#2449](#2449)) ([328544a](328544a))
@swirlds-automation
Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 0.43.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@swirlds-automation
Copy link
Copy Markdown
Contributor

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

PR: Needs Manager Approval A pull request that needs review from a manager. PR: Needs Team Approval A pull request that needs review from a team member. released on @0.43.x released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug: Hugo Docs Build Main / Build > Build Docs with Hugo passed even though there were failures within update_md.sh

4 participants