docs: added subcommands docs page #110
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dosubot
bot
added
size:L
There was a problem hiding this comment.
Thank you @karl-cardenas-coding! This is awesome and much appreciated. I regret to mention that some significant changes to these commands will be happening soon in validator-labs/validator#294.
|
@TylerGillson Thanks for the feedback. I went ahead and pushed up the changes :) |
Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
TylerGillson
previously approved these changes
Jul 31, 2024
Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
|
fyi @karl-cardenas-coding tests are breaking due to the version bump enforced via @ahmad-ibra is working on the fix in a separate PR. We'll update and merge this one as soon as his changes to properly upgrade the validator version are in. |
|
@karl-cardenas-coding heads up that we'll need to wait for #115 to be merged before this PR goes in. Once the PR i linked is merged the test failures we see in CI will be addressed. Edit: @TylerGillson beat me to the explanation 🙃 |
|
All good gents 👍 |
Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
TylerGillson
added a commit
that referenced
this pull request
Aug 1, 2024
## Issue Resolves #109 Resolves #98 ## Description Add `validatorctl docs` command to display supported versions of validator & validator plugins. Sample output:  Requires: - #110 --------- Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
N/A
Description
This PR adds a documentation page that goes into greater detail about each subcommand.