Skip to content

Documentation & CLI updates #98

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

Merged
merged 11 commits into from
Aug 3, 2022
Merged

Documentation & CLI updates #98

merged 11 commits into from
Aug 3, 2022

Conversation

mocsharp
Copy link
Collaborator

@mocsharp mocsharp commented Jul 6, 2022

Description

  • Updates CLI for 0.2.0 release
  • Updates setup instructions & CLI usages
  • Updates & approves third-party licenses

Status

Ready

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • All tests passed locally.
  • Documentation comments included/updated.
  • User guide updated.
  • I have updated the changelog

@mocsharp mocsharp added the documentation Improvements or additions to documentation label Jul 6, 2022
@mocsharp mocsharp added this to the 0.2.0 milestone Jul 6, 2022
@mocsharp mocsharp requested a review from rahul-imaging July 6, 2022 18:48
@mocsharp mocsharp self-assigned this Jul 6, 2022
@codecov
Copy link

codecov bot commented Jul 6, 2022

Codecov Report

Merging #98 (2e9346d) into develop (b9b2112) will decrease coverage by 0.02577%.
The diff coverage is 55.55556%.

Impacted file tree graph

@@                 Coverage Diff                 @@
##             develop         #98         +/-   ##
===================================================
- Coverage   93.65879%   93.63302%   -0.02577%     
===================================================
  Files            222         222                 
  Lines          13294       13303          +9     
  Branches         702         703          +1     
===================================================
+ Hits           12451       12456          +5     
- Misses           611         615          +4     
  Partials         232         232                 
Flag Coverage Δ
unittests 93.63302% <55.55556%> (-0.02577%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/CLI/Services/ConfigurationOptionAccessor.cs 3.63636% <0.00000%> (-0.28522%) ⬇️
src/CLI/Test/ControlExceptionTest.cs 100.00000% <ø> (ø)
src/CLI/Options/Common.cs 100.00000% <100.00000%> (ø)
src/CLI/Services/DockerRunner.cs 100.00000% <100.00000%> (ø)
src/CLI/Test/DockerRunnerTest.cs 100.00000% <100.00000%> (ø)
...Test/Services/Storage/SpaceReclaimerServiceTest.cs 94.79167% <0.00000%> (-2.08334%) ⬇️
...ateway/Services/Connectors/DataRetrievalService.cs 84.32602% <0.00000%> (+0.62695%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b9b2112...2e9346d. Read the comment docs.

mocsharp added 7 commits July 6, 2022 16:29
Signed-off-by: Victor Chang <[email protected]>
Signed-off-by: Victor Chang <[email protected]>
Signed-off-by: Victor Chang <[email protected]>
Signed-off-by: Victor Chang <[email protected]>
Signed-off-by: Victor Chang <[email protected]>
Signed-off-by: Victor Chang <[email protected]>
Signed-off-by: Victor Chang <[email protected]>
@mocsharp mocsharp requested review from jackschofield23 and neildsouth and removed request for joshliberty, rahul-imaging and JJFinnerty July 26, 2022 00:31
Signed-off-by: Victor Chang <[email protected]>
Signed-off-by: Victor Chang <[email protected]>
@mocsharp mocsharp merged commit d05f1e3 into develop Aug 3, 2022
@mocsharp mocsharp deleted the vchang/cli branch August 3, 2022 20:13
mocsharp added a commit that referenced this pull request Aug 19, 2022
* License approvals
* third-party license updates
* Documentation & CLI updates
* Update changelog
* [doc] Copyedit doc changes since previous copyedit pass (#101)
* Add CVE-2018-8292 to allowlist
* Update license headers

Signed-off-by: Victor Chang <[email protected]>
Co-authored-by: Coco-Ben <[email protected]>
@github-actions
Copy link

🎉 This issue has been resolved in version 0.2.0 🎉

The release is available on:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants