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

docs: add initial version of presentation layer cli design documentation #1777

Merged
merged 14 commits into from
Apr 2, 2025

Conversation

nathanklick
Copy link
Member

@nathanklick nathanklick commented Apr 1, 2025

Description

This pull request changes the following:

  • Adds the initial design documentation for the presentation layer and cli components

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

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:
  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

@nathanklick nathanklick added the P0 An issue impacting production environments or impacting multiple releases or multiple individuals. label Apr 1, 2025
@nathanklick nathanklick self-assigned this Apr 1, 2025
Copy link
Contributor

github-actions bot commented Apr 1, 2025

Unit Test Results - Linux

24 tests  ±0   24 ✅ ±0   0s ⏱️ ±0s
13 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit 77fd0c2. ± Comparison against base commit 8e8606c.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Apr 1, 2025

Unit Test Results - Windows

  1 files  ±0   70 suites  ±0   3s ⏱️ -1s
289 tests ±0  289 ✅ ±0  0 💤 ±0  0 ❌ ±0 
294 runs  ±0  294 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 77fd0c2. ± Comparison against base commit 8e8606c.

♻️ This comment has been updated with latest results.

@nathanklick nathanklick force-pushed the 01463-cli-design-docs branch from 02ca208 to c2502e0 Compare April 1, 2025 20:41
@nathanklick nathanklick marked this pull request as ready for review April 1, 2025 20:42
@nathanklick nathanklick requested review from a team as code owners April 1, 2025 20:42
jeromy-cannon
jeromy-cannon previously approved these changes Apr 1, 2025
Signed-off-by: Nathan Klick <[email protected]>
Signed-off-by: Nathan Klick <[email protected]>
Signed-off-by: Nathan Klick <[email protected]>
Signed-off-by: Nathan Klick <[email protected]>
Signed-off-by: Nathan Klick <[email protected]>
Signed-off-by: Nathan Klick <[email protected]>
Signed-off-by: Nathan Klick <[email protected]>
Signed-off-by: Nathan Klick <[email protected]>
Signed-off-by: Nathan Klick <[email protected]>
Signed-off-by: Nathan Klick <[email protected]>
Signed-off-by: Nathan Klick <[email protected]>
Signed-off-by: Nathan Klick <[email protected]>
@nathanklick nathanklick force-pushed the 01463-cli-design-docs branch from d0d1908 to 77fd0c2 Compare April 2, 2025 13:07
Copy link
Contributor

github-actions bot commented Apr 2, 2025

E2E Test Report

 17 files  ±0  117 suites  ±0   1h 29m 26s ⏱️ + 1m 14s
309 tests ±0  309 ✅ ±0  0 💤 ±0  0 ❌ ±0 
326 runs  ±0  326 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 77fd0c2. ± Comparison against base commit 8e8606c.

Copy link
Contributor

github-actions bot commented Apr 2, 2025

E2E Test Report

 17 files  ±0  117 suites  ±0   1h 29m 26s ⏱️ + 1m 14s
309 tests ±0  309 ✅ ±0  0 💤 ±0  0 ❌ ±0 
326 runs  ±0  326 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 77fd0c2. ± Comparison against base commit 8e8606c.

Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.08% (target: -1.00%) 100.00%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (8e8606c) 34822 28953 83.15%
Head commit (77fd0c2) 34825 (+3) 28983 (+30) 83.22% (+0.08%)

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 (#1777) 3 3 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

Copy link

codecov bot commented Apr 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.22%. Comparing base (8e8606c) to head (77fd0c2).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1777      +/-   ##
==========================================
+ Coverage   82.14%   82.22%   +0.07%     
==========================================
  Files         243      243              
  Lines       34822    34825       +3     
  Branches     2902     2197     -705     
==========================================
+ Hits        28605    28634      +29     
- Misses       6081     6168      +87     
+ Partials      136       23     -113     
Files with missing lines Coverage Δ
src/commands/network.ts 79.98% <100.00%> (+0.04%) ⬆️

... and 58 files with indirect coverage changes

Impacted file tree graph

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nathanklick nathanklick merged commit 01dd8d9 into main Apr 2, 2025
44 of 45 checks passed
@nathanklick nathanklick deleted the 01463-cli-design-docs branch April 2, 2025 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P0 An issue impacting production environments or impacting multiple releases or multiple individuals.
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants