-
Notifications
You must be signed in to change notification settings - Fork 249
Add simple CI usage documentation #970
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @TobiasCGoetz - I've reviewed your changes - here's some feedback:
- 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.
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:
|
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-resource
option especially important when dealing with manual changes to YAML files.#965