Skip to content

doc: Improve examples and generate documentation pages with typedoc support #139

doc: Improve examples and generate documentation pages with typedoc support

doc: Improve examples and generate documentation pages with typedoc support #139

Triggered via pull request December 15, 2024 15:15
@gosurigosuri
synchronize #111
docup
Status Failure
Total duration 23s
Artifacts

commit-lint.yml

on: pull_request
Commit Lint  /  Validate PR commits with commitlint
13s
Commit Lint / Validate PR commits with commitlint
Fit to window
Zoom out
Zoom in

Annotations

1 error and 1 warning
Commit Lint / Validate PR commits with commitlint
You have commit messages with errors ⧗ input: chore(deps): upgrade TypeScript to version 5.7.2 - Updated TypeScript to version 5.7.2 for improved features and performance. - Ensured compatibility with existing TypeScript configuration. Signed-off-by: Greg Osuri <[email protected]> ✖ scope must be one of [certificates, network, wallet, api, stargate, sdl, examples] [scope-enum] ✖ found 1 problems, 0 warnings ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint ⧗ input: Add example function to check endpoint health status - Implemented `checkEndpointHealth` function to demonstrate how to retrieve and log the health status of network endpoints. - Utilized `getEndpoints` and `getEndpointHealthStatus` to fetch and evaluate endpoint response times. - Included error handling to manage potential issues during the health check process. Signed-off-by: Greg Osuri <[email protected]> ✖ body's lines must not be longer than 100 characters [body-max-line-length] ✖ subject may not be empty [subject-empty] ✖ type may not be empty [type-empty] ✖ found 3 problems, 0 warnings ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint ⧗ input: docs: Enhance type definitions with detailed documentation - Added comprehensive comments to all type definitions in `src/sdl/types.ts`. - Improved clarity and understanding of v2 and v3 manifest structures. - Documented optional parameters and resource configurations for better developer guidance. - Ensured consistency in documentation style across all type definitions. Signed-off-by: Greg Osuri <[email protected]> ✖ subject must not be sentence-case, start-case, pascal-case, upper-case [subject-case] ✖ found 1 problems, 0 warnings ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
Commit Lint / Validate PR commits with commitlint
ubuntu-latest pipelines will use ubuntu-24.04 soon. For more details, see https://github.com/actions/runner-images/issues/10636