Skip to content

feat: add docs command; refactor to use embeddedfs pkg - #116

Merged
TylerGillson merged 4 commits into
mainfrom
feat/docs-command
Aug 1, 2024
Merged

feat: add docs command; refactor to use embeddedfs pkg#116
TylerGillson merged 4 commits into
mainfrom
feat/docs-command

Conversation

@TylerGillson

@TylerGillson TylerGillson commented Jul 31, 2024

Copy link
Copy Markdown
Member

Issue

Resolves #109
Resolves #98

Description

Add validatorctl docs command to display supported versions of validator & validator plugins.

Sample output:
Screen Shot 2024-07-31 at 2 45 56 PM

Requires:

Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
@TylerGillson
TylerGillson requested a review from a team as a code owner July 31, 2024 20:51
@dosubot dosubot Bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jul 31, 2024
@TylerGillson
TylerGillson requested review from mattwelke and removed request for arturshadnik July 31, 2024 20:52
@dosubot dosubot Bot added new-feature Net-new feature refactoring Refactoring / tech debt labels Jul 31, 2024
Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
@codecov

codecov Bot commented Aug 1, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 63.63636% with 12 lines in your changes missing coverage. Please review.

Files Patch % Lines
cmd/validator.go 58.82% 6 Missing and 1 partial ⚠️
pkg/cmd/validator/validator.go 66.66% 0 Missing and 3 partials ⚠️
pkg/logging/logger.go 0.00% 2 Missing ⚠️
@@            Coverage Diff             @@
##             main     #116      +/-   ##
==========================================
- Coverage   50.81%   50.80%   -0.01%     
==========================================
  Files          45       44       -1     
  Lines        4727     4710      -17     
==========================================
- Hits         2402     2393       -9     
+ Misses       1697     1695       -2     
+ Partials      628      622       -6     
Files Coverage Δ
cmd/root.go 70.17% <100.00%> (+0.53%) ⬆️
pkg/services/validator/vmware.go 41.47% <100.00%> (ø)
pkg/utils/kind/kind.go 53.00% <100.00%> (ø)
pkg/logging/logger.go 56.52% <0.00%> (-1.69%) ⬇️
pkg/cmd/validator/validator.go 51.49% <66.66%> (ø)
cmd/validator.go 79.67% <58.82%> (-3.35%) ⬇️

Continue to review full report in Codecov by Sentry.

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

@TylerGillson
TylerGillson merged commit dbe19c5 into main Aug 1, 2024
@TylerGillson
TylerGillson deleted the feat/docs-command branch August 1, 2024 17:45
TylerGillson added a commit that referenced this pull request Aug 6, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.1.0](v0.0.6...v0.1.0)
(2024-08-06)


### ⚠ BREAKING CHANGES

* split plugin rule configuration and installation into separate
commands
([#121](#121))

### Features

* add docs command; refactor to use embeddedfs pkg
([#116](#116))
([dbe19c5](dbe19c5))
* read CA certs for network rules, add HTTPFileRules, AMIRules
([#117](#117))
([0c4487f](0c4487f))
* support direct rule evaluation with `validator check --direct`
([#127](#127))
([f1fb0d6](f1fb0d6))


### Docs

* added subcommands docs page
([#110](#110))
([9fa23dc](9fa23dc))


### Dependency Updates

* **deps:** update github.com/validator-labs/validator-plugin-azure
digest to ba947e3
([#134](#134))
([2a1058d](2a1058d))
* **deps:** update github.com/validator-labs/validator-plugin-vsphere
digest to 9b1f05b
([#135](#135))
([253f328](253f328))


### Refactoring

* remove -s flag
([#126](#126))
([9373e02](9373e02))
* simplify helm prompts
([#115](#115))
([8ce75a1](8ce75a1))
* split plugin rule configuration and installation into separate
commands
([#121](#121))
([6eaee77](6eaee77))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new-feature Net-new feature refactoring Refactoring / tech debt size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

🎨 Replace embed pkg with embeddedfs ✨ List plugins in CLI via validator docs

1 participant