Add simple CI usage documentation#970
Merged
rhybrillou merged 5 commits intostackrox:mainfrom Jul 14, 2025
TobiasCGoetz:TobiasCGoetz-ci-docs
Merged
Add simple CI usage documentation#970rhybrillou merged 5 commits intostackrox:mainfrom TobiasCGoetz:TobiasCGoetz-ci-docs
rhybrillou merged 5 commits intostackrox:mainfrom
TobiasCGoetz:TobiasCGoetz-ci-docs
Conversation
There was a problem hiding this comment.
Hey @TobiasCGoetz - I've reviewed your changes - here's some feedback:
- The JSON parsing snippet with grep/awk is brittle; consider using
jqor the GitHub CLI to reliably fetch the latest release URL. - The relative link
README.md##kubelinter-github-actionmay not render correctly—update it to a valid Markdown anchor or full URL for the GitHub Action.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The JSON parsing snippet with grep/awk is brittle; consider using `jq` or the GitHub CLI to reliably fetch the latest release URL.
- The relative link `README.md##kubelinter-github-action` may not render correctly—update it to a valid Markdown anchor or full URL for the GitHub Action.
## Individual Comments
### Comment 1
<location> `docs/using-kubelinter.md:65` </location>
<code_context>
+## Using KubeLinter as part of your CI pipeline
+
+If you're using Github, there's the [KubeLinter Github Action](README.md##kubelinter-github-action) available.
+
+Alternatively, you can grab the latest binary release with the following commands
</code_context>
<issue_to_address>
Correct 'Github' to 'GitHub' for proper branding.
Update all instances to 'GitHub' for consistency.
</issue_to_address>
<suggested_fix>
<<<<<<< SEARCH
If you're using Github, there's the [KubeLinter Github Action](README.md##kubelinter-github-action) available.
=======
If you're using GitHub, there's the [KubeLinter GitHub Action](README.md##kubelinter-github-action) available.
>>>>>>> REPLACE
</suggested_fix>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #970 +/- ##
===========================================
- Coverage 62.36% 28.66% -33.70%
===========================================
Files 197 209 +12
Lines 4854 5947 +1093
===========================================
- Hits 3027 1705 -1322
- Misses 1439 4126 +2687
+ Partials 388 116 -272
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
rhybrillou
approved these changes
Jul 14, 2025
This file contains hidden or 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
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.
Hi,
I added some basic documentation for using KubeLinter as part of a CI pipeline. While there is a Github Action available, I might not be the only one interested in running it elsewhere. I found the
--fail-on-invalid-resourceoption especially important when dealing with manual changes to YAML files.#965